diff --git a/gooddata-afm-client/.openapi-generator-ignore b/gooddata-afm-client/.openapi-generator-ignore new file mode 100644 index 000000000..6239daebe --- /dev/null +++ b/gooddata-afm-client/.openapi-generator-ignore @@ -0,0 +1,6 @@ +# (C) 2022 GoodData Corporation +.openapi-generator-ignore +.gitlab-ci.yml +.travis.yml +git_push.sh +test/** diff --git a/gooddata-afm-client/LICENSE.txt b/gooddata-afm-client/LICENSE.txt new file mode 120000 index 000000000..ac8dea2c9 --- /dev/null +++ b/gooddata-afm-client/LICENSE.txt @@ -0,0 +1 @@ +../OSS LICENSES/LICENSE (gooddata-afm-client).txt \ No newline at end of file diff --git a/gooddata-api-client/.openapi-generator/FILES b/gooddata-api-client/.openapi-generator/FILES index 2b88e4452..818c402a0 100644 --- a/gooddata-api-client/.openapi-generator/FILES +++ b/gooddata-api-client/.openapi-generator/FILES @@ -98,7 +98,6 @@ docs/AppearanceApi.md docs/ArithmeticMeasure.md docs/ArithmeticMeasureDefinition.md docs/ArithmeticMeasureDefinitionArithmeticMeasure.md -docs/Array.md docs/AssigneeIdentifier.md docs/AssigneeRule.md docs/AttributeElements.md @@ -545,6 +544,7 @@ docs/JsonApiCustomApplicationSettingPatchDocument.md docs/JsonApiCustomApplicationSettingPostOptionalId.md docs/JsonApiCustomApplicationSettingPostOptionalIdDocument.md docs/JsonApiCustomGeoCollectionIn.md +docs/JsonApiCustomGeoCollectionInAttributes.md docs/JsonApiCustomGeoCollectionInDocument.md docs/JsonApiCustomGeoCollectionOut.md docs/JsonApiCustomGeoCollectionOutDocument.md @@ -903,6 +903,7 @@ docs/JsonApiVisualizationObjectPostOptionalIdDocument.md docs/JsonApiVisualizationObjectToManyLinkage.md docs/JsonApiVisualizationObjectToOneLinkage.md docs/JsonApiWorkspaceAutomationOut.md +docs/JsonApiWorkspaceAutomationOutAttributes.md docs/JsonApiWorkspaceAutomationOutIncludes.md docs/JsonApiWorkspaceAutomationOutList.md docs/JsonApiWorkspaceAutomationOutRelationships.md @@ -1377,7 +1378,6 @@ gooddata_api_client/model/api_entitlement.py gooddata_api_client/model/arithmetic_measure.py gooddata_api_client/model/arithmetic_measure_definition.py gooddata_api_client/model/arithmetic_measure_definition_arithmetic_measure.py -gooddata_api_client/model/array.py gooddata_api_client/model/assignee_identifier.py gooddata_api_client/model/assignee_rule.py gooddata_api_client/model/attribute_elements.py @@ -1796,6 +1796,7 @@ gooddata_api_client/model/json_api_custom_application_setting_patch_document.py gooddata_api_client/model/json_api_custom_application_setting_post_optional_id.py gooddata_api_client/model/json_api_custom_application_setting_post_optional_id_document.py gooddata_api_client/model/json_api_custom_geo_collection_in.py +gooddata_api_client/model/json_api_custom_geo_collection_in_attributes.py gooddata_api_client/model/json_api_custom_geo_collection_in_document.py gooddata_api_client/model/json_api_custom_geo_collection_out.py gooddata_api_client/model/json_api_custom_geo_collection_out_document.py @@ -2154,6 +2155,7 @@ gooddata_api_client/model/json_api_visualization_object_post_optional_id_documen gooddata_api_client/model/json_api_visualization_object_to_many_linkage.py gooddata_api_client/model/json_api_visualization_object_to_one_linkage.py gooddata_api_client/model/json_api_workspace_automation_out.py +gooddata_api_client/model/json_api_workspace_automation_out_attributes.py gooddata_api_client/model/json_api_workspace_automation_out_includes.py gooddata_api_client/model/json_api_workspace_automation_out_list.py gooddata_api_client/model/json_api_workspace_automation_out_relationships.py diff --git a/gooddata-api-client/README.md b/gooddata-api-client/README.md index c3efac334..016cd6348 100644 --- a/gooddata-api-client/README.md +++ b/gooddata-api-client/README.md @@ -1227,7 +1227,6 @@ Class | Method | HTTP request | Description - [ArithmeticMeasure](docs/ArithmeticMeasure.md) - [ArithmeticMeasureDefinition](docs/ArithmeticMeasureDefinition.md) - [ArithmeticMeasureDefinitionArithmeticMeasure](docs/ArithmeticMeasureDefinitionArithmeticMeasure.md) - - [Array](docs/Array.md) - [AssigneeIdentifier](docs/AssigneeIdentifier.md) - [AssigneeRule](docs/AssigneeRule.md) - [AttributeElements](docs/AttributeElements.md) @@ -1646,6 +1645,7 @@ Class | Method | HTTP request | Description - [JsonApiCustomApplicationSettingPostOptionalId](docs/JsonApiCustomApplicationSettingPostOptionalId.md) - [JsonApiCustomApplicationSettingPostOptionalIdDocument](docs/JsonApiCustomApplicationSettingPostOptionalIdDocument.md) - [JsonApiCustomGeoCollectionIn](docs/JsonApiCustomGeoCollectionIn.md) + - [JsonApiCustomGeoCollectionInAttributes](docs/JsonApiCustomGeoCollectionInAttributes.md) - [JsonApiCustomGeoCollectionInDocument](docs/JsonApiCustomGeoCollectionInDocument.md) - [JsonApiCustomGeoCollectionOut](docs/JsonApiCustomGeoCollectionOut.md) - [JsonApiCustomGeoCollectionOutDocument](docs/JsonApiCustomGeoCollectionOutDocument.md) @@ -2004,6 +2004,7 @@ Class | Method | HTTP request | Description - [JsonApiVisualizationObjectToManyLinkage](docs/JsonApiVisualizationObjectToManyLinkage.md) - [JsonApiVisualizationObjectToOneLinkage](docs/JsonApiVisualizationObjectToOneLinkage.md) - [JsonApiWorkspaceAutomationOut](docs/JsonApiWorkspaceAutomationOut.md) + - [JsonApiWorkspaceAutomationOutAttributes](docs/JsonApiWorkspaceAutomationOutAttributes.md) - [JsonApiWorkspaceAutomationOutIncludes](docs/JsonApiWorkspaceAutomationOutIncludes.md) - [JsonApiWorkspaceAutomationOutList](docs/JsonApiWorkspaceAutomationOutList.md) - [JsonApiWorkspaceAutomationOutRelationships](docs/JsonApiWorkspaceAutomationOutRelationships.md) diff --git a/gooddata-api-client/docs/AbsoluteDateFilterAbsoluteDateFilter.md b/gooddata-api-client/docs/AbsoluteDateFilterAbsoluteDateFilter.md index b9e2720f2..a82af8ee5 100644 --- a/gooddata-api-client/docs/AbsoluteDateFilterAbsoluteDateFilter.md +++ b/gooddata-api-client/docs/AbsoluteDateFilterAbsoluteDateFilter.md @@ -8,7 +8,6 @@ Name | Type | Description | Notes **_from** | **str** | | **to** | **str** | | **apply_on_result** | **bool** | | [optional] -**include_empty_values** | **bool** | If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition). | [optional] **local_identifier** | **str** | | [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/ActionsApi.md b/gooddata-api-client/docs/ActionsApi.md index f743d2b3f..a923c6c26 100644 --- a/gooddata-api-client/docs/ActionsApi.md +++ b/gooddata-api-client/docs/ActionsApi.md @@ -7473,6 +7473,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], ), + interval="DAY", trigger="ALWAYS", ), analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -7527,7 +7528,16 @@ with gooddata_api_client.ApiClient() as api_client: ), ), ], - metadata=AutomationMetadata(), + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), notification_channel=DeclarativeNotificationChannelIdentifier( id="webhook123", type="notificationChannel", diff --git a/gooddata-api-client/docs/AfmObjectIdentifierDataset.md b/gooddata-api-client/docs/AfmObjectIdentifierDataset.md index e8b2b2c97..1f02b1d8d 100644 --- a/gooddata-api-client/docs/AfmObjectIdentifierDataset.md +++ b/gooddata-api-client/docs/AfmObjectIdentifierDataset.md @@ -1,6 +1,6 @@ # AfmObjectIdentifierDataset -Reference to the date dataset to which the filter should be applied. +Date dataset used for anomaly detection. ## Properties Name | Type | Description | Notes diff --git a/gooddata-api-client/docs/Array.md b/gooddata-api-client/docs/Array.md deleted file mode 100644 index 49ebc4007..000000000 --- a/gooddata-api-client/docs/Array.md +++ /dev/null @@ -1,11 +0,0 @@ -# Array - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**value** | **[str]** | | - -[[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/AutomationAlert.md b/gooddata-api-client/docs/AutomationAlert.md index 15a95153d..32736e5de 100644 --- a/gooddata-api-client/docs/AutomationAlert.md +++ b/gooddata-api-client/docs/AutomationAlert.md @@ -6,7 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **condition** | [**AutomationAlertCondition**](AutomationAlertCondition.md) | | **execution** | [**AlertAfm**](AlertAfm.md) | | -**trigger** | **str** | Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. | [optional] if omitted the server will use the default value of "ALWAYS" +**interval** | **str** | Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR. | [optional] +**trigger** | **str** | Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS. | [optional] if omitted the server will use the default value of "ALWAYS" **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/AutomationsApi.md b/gooddata-api-client/docs/AutomationsApi.md index 237805b3d..8abbd10c4 100644 --- a/gooddata-api-client/docs/AutomationsApi.md +++ b/gooddata-api-client/docs/AutomationsApi.md @@ -91,6 +91,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], ), + interval="DAY", trigger="ALWAYS", ), are_relations_valid=True, @@ -141,7 +142,16 @@ with gooddata_api_client.ApiClient() as api_client: ), ), ], - metadata=JsonApiAutomationInAttributesMetadata(), + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), raw_exports=[ JsonApiAutomationInAttributesRawExportsInner( request_payload=RawExportAutomationRequest( @@ -995,6 +1005,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], ), + interval="DAY", trigger="ALWAYS", ), are_relations_valid=True, @@ -1045,7 +1056,16 @@ with gooddata_api_client.ApiClient() as api_client: ), ), ], - metadata=JsonApiAutomationInAttributesMetadata(), + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), raw_exports=[ JsonApiAutomationInAttributesRawExportsInner( request_payload=RawExportAutomationRequest( @@ -1674,6 +1694,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], ), + interval="DAY", trigger="ALWAYS", ), analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -1741,7 +1762,16 @@ with gooddata_api_client.ApiClient() as api_client: ), ), ], - metadata=AutomationMetadata(), + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", @@ -2000,6 +2030,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], ), + interval="DAY", trigger="ALWAYS", ), analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -2054,7 +2085,16 @@ with gooddata_api_client.ApiClient() as api_client: ), ), ], - metadata=AutomationMetadata(), + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), notification_channel=DeclarativeNotificationChannelIdentifier( id="webhook123", type="notificationChannel", @@ -2841,6 +2881,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], ), + interval="DAY", trigger="ALWAYS", ), are_relations_valid=True, @@ -2891,7 +2932,16 @@ with gooddata_api_client.ApiClient() as api_client: ), ), ], - metadata=JsonApiAutomationInAttributesMetadata(), + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), raw_exports=[ JsonApiAutomationInAttributesRawExportsInner( request_payload=RawExportAutomationRequest( diff --git a/gooddata-api-client/docs/DashboardDateFilterDateFilter.md b/gooddata-api-client/docs/DashboardDateFilterDateFilter.md index 58cc3712c..9e3b0428f 100644 --- a/gooddata-api-client/docs/DashboardDateFilterDateFilter.md +++ b/gooddata-api-client/docs/DashboardDateFilterDateFilter.md @@ -10,7 +10,6 @@ Name | Type | Description | Notes **bounded_filter** | [**RelativeBoundedDateFilter**](RelativeBoundedDateFilter.md) | | [optional] **data_set** | [**IdentifierRef**](IdentifierRef.md) | | [optional] **_from** | [**AacDashboardFilterFrom**](AacDashboardFilterFrom.md) | | [optional] -**include_empty_values** | **bool** | | [optional] **local_identifier** | **str** | | [optional] **to** | [**AacDashboardFilterFrom**](AacDashboardFilterFrom.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/DeclarativeCustomApplicationSetting.md b/gooddata-api-client/docs/DeclarativeCustomApplicationSetting.md index 0e7628867..d3e35dd49 100644 --- a/gooddata-api-client/docs/DeclarativeCustomApplicationSetting.md +++ b/gooddata-api-client/docs/DeclarativeCustomApplicationSetting.md @@ -6,7 +6,7 @@ Custom application setting and its value. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **application_name** | **str** | The application id | -**content** | [**JsonNode**](JsonNode.md) | | +**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Free-form JSON content. Maximum supported length is 250000 characters. | **id** | **str** | Custom Application Setting ID. | **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/DeclarativeCustomGeoCollection.md b/gooddata-api-client/docs/DeclarativeCustomGeoCollection.md index 10dc654b7..b906f090a 100644 --- a/gooddata-api-client/docs/DeclarativeCustomGeoCollection.md +++ b/gooddata-api-client/docs/DeclarativeCustomGeoCollection.md @@ -6,6 +6,8 @@ A declarative form of custom geo collection. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Custom geo collection ID. | +**description** | **str** | Description of the custom geo collection. | [optional] +**name** | **str** | Name of the custom geo collection. | [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/EntitiesApi.md b/gooddata-api-client/docs/EntitiesApi.md index da11849a8..d07e5156b 100644 --- a/gooddata-api-client/docs/EntitiesApi.md +++ b/gooddata-api-client/docs/EntitiesApi.md @@ -582,6 +582,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], ), + interval="DAY", trigger="ALWAYS", ), are_relations_valid=True, @@ -632,7 +633,16 @@ with gooddata_api_client.ApiClient() as api_client: ), ), ], - metadata=JsonApiAutomationInAttributesMetadata(), + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), raw_exports=[ JsonApiAutomationInAttributesRawExportsInner( request_payload=RawExportAutomationRequest( @@ -1131,6 +1141,10 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) json_api_custom_geo_collection_in_document = JsonApiCustomGeoCollectionInDocument( data=JsonApiCustomGeoCollectionIn( + attributes=JsonApiCustomGeoCollectionInAttributes( + description="description_example", + name="name_example", + ), id="id1", type="customGeoCollection", ), @@ -3471,7 +3485,7 @@ with gooddata_api_client.ApiClient() as api_client: "parent", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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=config,permissions,hierarchy,dataModelDatasets,all", + "metaInclude=permissions,config,hierarchy,dataModelDatasets,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -4071,7 +4085,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) id = "/6bUUGjjNSwg0_bs" # 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) + 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: @@ -6822,7 +6836,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - filter = "" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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) 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 = [ @@ -9542,7 +9556,7 @@ with gooddata_api_client.ApiClient() as api_client: "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=config,permissions,hierarchy,dataModelDatasets,page,all", + "metaInclude=permissions,config,hierarchy,dataModelDatasets,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -10569,7 +10583,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) id = "/6bUUGjjNSwg0_bs" # 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) + 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: @@ -13210,7 +13224,7 @@ with gooddata_api_client.ApiClient() as api_client: "parent", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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=config,permissions,hierarchy,dataModelDatasets,all", + "metaInclude=permissions,config,hierarchy,dataModelDatasets,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -13694,6 +13708,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], ), + interval="DAY", trigger="ALWAYS", ), are_relations_valid=True, @@ -13744,7 +13759,16 @@ with gooddata_api_client.ApiClient() as api_client: ), ), ], - metadata=JsonApiAutomationInAttributesMetadata(), + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), raw_exports=[ JsonApiAutomationInAttributesRawExportsInner( request_payload=RawExportAutomationRequest( @@ -14357,11 +14381,15 @@ with gooddata_api_client.ApiClient() as 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 = "" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: @@ -19616,6 +19644,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], ), + interval="DAY", trigger="ALWAYS", ), are_relations_valid=True, @@ -19666,7 +19695,16 @@ with gooddata_api_client.ApiClient() as api_client: ), ), ], - metadata=JsonApiAutomationInAttributesMetadata(), + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), raw_exports=[ JsonApiAutomationInAttributesRawExportsInner( request_payload=RawExportAutomationRequest( @@ -20279,11 +20317,15 @@ with gooddata_api_client.ApiClient() as 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 = "" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: diff --git a/gooddata-api-client/docs/GeographicDataApi.md b/gooddata-api-client/docs/GeographicDataApi.md index e3f323ac7..56ca7ec93 100644 --- a/gooddata-api-client/docs/GeographicDataApi.md +++ b/gooddata-api-client/docs/GeographicDataApi.md @@ -40,6 +40,10 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = geographic_data_api.GeographicDataApi(api_client) json_api_custom_geo_collection_in_document = JsonApiCustomGeoCollectionInDocument( data=JsonApiCustomGeoCollectionIn( + attributes=JsonApiCustomGeoCollectionInAttributes( + description="description_example", + name="name_example", + ), id="id1", type="customGeoCollection", ), @@ -107,7 +111,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = geographic_data_api.GeographicDataApi(api_client) id = "/6bUUGjjNSwg0_bs" # 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) + 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: @@ -178,7 +182,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = geographic_data_api.GeographicDataApi(api_client) - filter = "" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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) 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 = [ @@ -256,7 +260,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = geographic_data_api.GeographicDataApi(api_client) id = "/6bUUGjjNSwg0_bs" # 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) + 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: @@ -333,11 +337,15 @@ with gooddata_api_client.ApiClient() as 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 = "" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: @@ -415,11 +423,15 @@ with gooddata_api_client.ApiClient() as 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 = "" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutAttributes.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutAttributes.md index 4d6065dd1..f845db7fc 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutAttributes.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 250000 characters. | **are_relations_valid** | **bool** | | [optional] -**created_at** | **datetime** | | [optional] +**created_at** | **datetime, none_type** | Time of the entity creation. | [optional] **description** | **str** | | [optional] -**modified_at** | **datetime** | | [optional] +**modified_at** | **datetime, none_type** | Time of the last entity modification. | [optional] **summary** | **str** | AI-generated summary of the dashboard content | [optional] **tags** | **[str]** | | [optional] **title** | **str** | | [optional] diff --git a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutAttributes.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutAttributes.md index 268682ff7..c307bdfb1 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutAttributes.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] **content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 15000 characters. | [optional] -**created_at** | **datetime** | | [optional] +**created_at** | **datetime, none_type** | Time of the entity creation. | [optional] **description** | **str** | | [optional] -**modified_at** | **datetime** | | [optional] +**modified_at** | **datetime, none_type** | Time of the last entity modification. | [optional] **tags** | **[str]** | | [optional] **title** | **str** | | [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/JsonApiAutomationInAttributesAlert.md b/gooddata-api-client/docs/JsonApiAutomationInAttributesAlert.md index 4e60a9baa..743bb8a3e 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInAttributesAlert.md +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributesAlert.md @@ -6,7 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **condition** | [**AlertCondition**](AlertCondition.md) | | **execution** | [**AlertAfm**](AlertAfm.md) | | -**trigger** | **str** | Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. | [optional] if omitted the server will use the default value of "ALWAYS" +**interval** | **str** | Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR. | [optional] +**trigger** | **str** | Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS. | [optional] if omitted the server will use the default value of "ALWAYS" **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/JsonApiAutomationOutAttributes.md b/gooddata-api-client/docs/JsonApiAutomationOutAttributes.md index 557272afe..1fa3d4766 100644 --- a/gooddata-api-client/docs/JsonApiAutomationOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiAutomationOutAttributes.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **alert** | [**JsonApiAutomationInAttributesAlert**](JsonApiAutomationInAttributesAlert.md) | | [optional] **are_relations_valid** | **bool** | | [optional] -**created_at** | **datetime** | | [optional] +**created_at** | **datetime, none_type** | Time of the entity creation. | [optional] **dashboard_tabular_exports** | [**[JsonApiAutomationInAttributesDashboardTabularExportsInner]**](JsonApiAutomationInAttributesDashboardTabularExportsInner.md) | | [optional] **description** | **str** | | [optional] **details** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Additional details to be included in the automated message. | [optional] @@ -14,7 +14,7 @@ Name | Type | Description | Notes **external_recipients** | [**[JsonApiAutomationInAttributesExternalRecipientsInner]**](JsonApiAutomationInAttributesExternalRecipientsInner.md) | External recipients of the automation action results. | [optional] **image_exports** | [**[JsonApiAutomationInAttributesImageExportsInner]**](JsonApiAutomationInAttributesImageExportsInner.md) | | [optional] **metadata** | [**JsonApiAutomationInAttributesMetadata**](JsonApiAutomationInAttributesMetadata.md) | | [optional] -**modified_at** | **datetime** | | [optional] +**modified_at** | **datetime, none_type** | Time of the last entity modification. | [optional] **raw_exports** | [**[JsonApiAutomationInAttributesRawExportsInner]**](JsonApiAutomationInAttributesRawExportsInner.md) | | [optional] **schedule** | [**JsonApiAutomationInAttributesSchedule**](JsonApiAutomationInAttributesSchedule.md) | | [optional] **slides_exports** | [**[JsonApiAutomationInAttributesSlidesExportsInner]**](JsonApiAutomationInAttributesSlidesExportsInner.md) | | [optional] diff --git a/gooddata-api-client/docs/JsonApiCustomApplicationSettingInAttributes.md b/gooddata-api-client/docs/JsonApiCustomApplicationSettingInAttributes.md index 8b2a58d90..d80bf2439 100644 --- a/gooddata-api-client/docs/JsonApiCustomApplicationSettingInAttributes.md +++ b/gooddata-api-client/docs/JsonApiCustomApplicationSettingInAttributes.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **application_name** | **str** | | -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 15000 characters. | +**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 250000 characters. | **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/JsonApiCustomApplicationSettingPatchAttributes.md b/gooddata-api-client/docs/JsonApiCustomApplicationSettingPatchAttributes.md index 729304b8a..acd133bbc 100644 --- a/gooddata-api-client/docs/JsonApiCustomApplicationSettingPatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiCustomApplicationSettingPatchAttributes.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **application_name** | **str** | | [optional] -**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 15000 characters. | [optional] +**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 250000 characters. | [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/JsonApiCustomGeoCollectionIn.md b/gooddata-api-client/docs/JsonApiCustomGeoCollectionIn.md index ba4cdd2d6..550b9c50a 100644 --- a/gooddata-api-client/docs/JsonApiCustomGeoCollectionIn.md +++ b/gooddata-api-client/docs/JsonApiCustomGeoCollectionIn.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "customGeoCollection" +**attributes** | [**JsonApiCustomGeoCollectionInAttributes**](JsonApiCustomGeoCollectionInAttributes.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/JsonApiCustomGeoCollectionInAttributes.md b/gooddata-api-client/docs/JsonApiCustomGeoCollectionInAttributes.md new file mode 100644 index 000000000..200a7380a --- /dev/null +++ b/gooddata-api-client/docs/JsonApiCustomGeoCollectionInAttributes.md @@ -0,0 +1,13 @@ +# JsonApiCustomGeoCollectionInAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str, none_type** | | [optional] +**name** | **str, none_type** | | [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/JsonApiCustomGeoCollectionOut.md b/gooddata-api-client/docs/JsonApiCustomGeoCollectionOut.md index 734f0dd8b..b5bb6b655 100644 --- a/gooddata-api-client/docs/JsonApiCustomGeoCollectionOut.md +++ b/gooddata-api-client/docs/JsonApiCustomGeoCollectionOut.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "customGeoCollection" +**attributes** | [**JsonApiCustomGeoCollectionInAttributes**](JsonApiCustomGeoCollectionInAttributes.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/JsonApiCustomGeoCollectionOutWithLinks.md b/gooddata-api-client/docs/JsonApiCustomGeoCollectionOutWithLinks.md index 0c0ec5735..1d9638449 100644 --- a/gooddata-api-client/docs/JsonApiCustomGeoCollectionOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiCustomGeoCollectionOutWithLinks.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "customGeoCollection" +**attributes** | [**JsonApiCustomGeoCollectionInAttributes**](JsonApiCustomGeoCollectionInAttributes.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/JsonApiCustomGeoCollectionPatch.md b/gooddata-api-client/docs/JsonApiCustomGeoCollectionPatch.md index 21d2d85fd..377d2a216 100644 --- a/gooddata-api-client/docs/JsonApiCustomGeoCollectionPatch.md +++ b/gooddata-api-client/docs/JsonApiCustomGeoCollectionPatch.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "customGeoCollection" +**attributes** | [**JsonApiCustomGeoCollectionInAttributes**](JsonApiCustomGeoCollectionInAttributes.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/JsonApiDashboardPluginOutAttributes.md b/gooddata-api-client/docs/JsonApiDashboardPluginOutAttributes.md index 7c298a0b9..39658af45 100644 --- a/gooddata-api-client/docs/JsonApiDashboardPluginOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiDashboardPluginOutAttributes.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] **content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 250000 characters. | [optional] -**created_at** | **datetime** | | [optional] +**created_at** | **datetime, none_type** | Time of the entity creation. | [optional] **description** | **str** | | [optional] -**modified_at** | **datetime** | | [optional] +**modified_at** | **datetime, none_type** | Time of the last entity modification. | [optional] **tags** | **[str]** | | [optional] **title** | **str** | | [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/JsonApiExportDefinitionOutAttributes.md b/gooddata-api-client/docs/JsonApiExportDefinitionOutAttributes.md index 025f96d45..ef9b55e8e 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionOutAttributes.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] -**created_at** | **datetime** | | [optional] +**created_at** | **datetime, none_type** | Time of the entity creation. | [optional] **description** | **str** | | [optional] -**modified_at** | **datetime** | | [optional] +**modified_at** | **datetime, none_type** | Time of the last entity modification. | [optional] **request_payload** | [**JsonApiExportDefinitionInAttributesRequestPayload**](JsonApiExportDefinitionInAttributesRequestPayload.md) | | [optional] **tags** | **[str]** | | [optional] **title** | **str** | | [optional] diff --git a/gooddata-api-client/docs/JsonApiMemoryItemOutAttributes.md b/gooddata-api-client/docs/JsonApiMemoryItemOutAttributes.md index 5d1e30444..0a7ec8ab3 100644 --- a/gooddata-api-client/docs/JsonApiMemoryItemOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiMemoryItemOutAttributes.md @@ -7,11 +7,11 @@ Name | Type | Description | Notes **instruction** | **str** | The text that will be injected into the system prompt | **strategy** | **str** | Strategy defining when the memory item should be applied | **are_relations_valid** | **bool** | | [optional] -**created_at** | **datetime** | | [optional] +**created_at** | **datetime, none_type** | Time of the entity creation. | [optional] **description** | **str** | | [optional] **is_disabled** | **bool** | Whether memory item is disabled | [optional] **keywords** | **[str]** | Set of unique strings used for semantic similarity filtering | [optional] -**modified_at** | **datetime** | | [optional] +**modified_at** | **datetime, none_type** | Time of the last entity modification. | [optional] **tags** | **[str]** | | [optional] **title** | **str** | | [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/JsonApiMetricOutAttributes.md b/gooddata-api-client/docs/JsonApiMetricOutAttributes.md index 7d355c82e..63d76ef31 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiMetricOutAttributes.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **content** | [**JsonApiMetricInAttributesContent**](JsonApiMetricInAttributesContent.md) | | **are_relations_valid** | **bool** | | [optional] -**created_at** | **datetime** | | [optional] +**created_at** | **datetime, none_type** | Time of the entity creation. | [optional] **description** | **str** | | [optional] **is_hidden** | **bool** | | [optional] **is_hidden_from_kda** | **bool** | | [optional] -**modified_at** | **datetime** | | [optional] +**modified_at** | **datetime, none_type** | Time of the last entity modification. | [optional] **tags** | **[str]** | | [optional] **title** | **str** | | [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/JsonApiVisualizationObjectOutAttributes.md b/gooddata-api-client/docs/JsonApiVisualizationObjectOutAttributes.md index aa4936193..3e1da6b2d 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectOutAttributes.md @@ -6,10 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 250000 characters. | **are_relations_valid** | **bool** | | [optional] -**created_at** | **datetime** | | [optional] +**created_at** | **datetime, none_type** | Time of the entity creation. | [optional] **description** | **str** | | [optional] **is_hidden** | **bool** | | [optional] -**modified_at** | **datetime** | | [optional] +**modified_at** | **datetime, none_type** | Time of the last entity modification. | [optional] **tags** | **[str]** | | [optional] **title** | **str** | | [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/JsonApiWorkspaceAutomationOut.md b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOut.md index 2d820f1c2..fe55ae682 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOut.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOut.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "workspaceAutomation" -**attributes** | [**JsonApiAutomationOutAttributes**](JsonApiAutomationOutAttributes.md) | | [optional] +**attributes** | [**JsonApiWorkspaceAutomationOutAttributes**](JsonApiWorkspaceAutomationOutAttributes.md) | | [optional] **relationships** | [**JsonApiWorkspaceAutomationOutRelationships**](JsonApiWorkspaceAutomationOutRelationships.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/JsonApiWorkspaceAutomationOutAttributes.md b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutAttributes.md new file mode 100644 index 000000000..0839a69be --- /dev/null +++ b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutAttributes.md @@ -0,0 +1,30 @@ +# JsonApiWorkspaceAutomationOutAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**alert** | [**JsonApiAutomationInAttributesAlert**](JsonApiAutomationInAttributesAlert.md) | | [optional] +**are_relations_valid** | **bool** | | [optional] +**created_at** | **datetime** | | [optional] +**dashboard_tabular_exports** | [**[JsonApiAutomationInAttributesDashboardTabularExportsInner]**](JsonApiAutomationInAttributesDashboardTabularExportsInner.md) | | [optional] +**description** | **str** | | [optional] +**details** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Additional details to be included in the automated message. | [optional] +**evaluation_mode** | **str** | Specify automation evaluation mode. | [optional] +**external_recipients** | [**[JsonApiAutomationInAttributesExternalRecipientsInner]**](JsonApiAutomationInAttributesExternalRecipientsInner.md) | External recipients of the automation action results. | [optional] +**image_exports** | [**[JsonApiAutomationInAttributesImageExportsInner]**](JsonApiAutomationInAttributesImageExportsInner.md) | | [optional] +**metadata** | [**JsonApiAutomationInAttributesMetadata**](JsonApiAutomationInAttributesMetadata.md) | | [optional] +**modified_at** | **datetime** | | [optional] +**raw_exports** | [**[JsonApiAutomationInAttributesRawExportsInner]**](JsonApiAutomationInAttributesRawExportsInner.md) | | [optional] +**schedule** | [**JsonApiAutomationInAttributesSchedule**](JsonApiAutomationInAttributesSchedule.md) | | [optional] +**slides_exports** | [**[JsonApiAutomationInAttributesSlidesExportsInner]**](JsonApiAutomationInAttributesSlidesExportsInner.md) | | [optional] +**state** | **str** | Current state of the automation. | [optional] +**tabular_exports** | [**[JsonApiAutomationInAttributesTabularExportsInner]**](JsonApiAutomationInAttributesTabularExportsInner.md) | | [optional] +**tags** | **[str]** | | [optional] +**title** | **str** | | [optional] +**visual_exports** | [**[JsonApiAutomationInAttributesVisualExportsInner]**](JsonApiAutomationInAttributesVisualExportsInner.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/JsonApiWorkspaceAutomationOutWithLinks.md b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutWithLinks.md index 7deb265a1..cbcf9f190 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceAutomationOutWithLinks.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "workspaceAutomation" -**attributes** | [**JsonApiAutomationOutAttributes**](JsonApiAutomationOutAttributes.md) | | [optional] +**attributes** | [**JsonApiWorkspaceAutomationOutAttributes**](JsonApiWorkspaceAutomationOutAttributes.md) | | [optional] **relationships** | [**JsonApiWorkspaceAutomationOutRelationships**](JsonApiWorkspaceAutomationOutRelationships.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/JsonNode.md b/gooddata-api-client/docs/JsonNode.md index 61f8c53c6..bbb9c7e3e 100644 --- a/gooddata-api-client/docs/JsonNode.md +++ b/gooddata-api-client/docs/JsonNode.md @@ -1,6 +1,6 @@ # JsonNode -Free-form JSON object +Metadata definition in free-form JSON format. ## Properties Name | Type | Description | Notes diff --git a/gooddata-api-client/docs/LayoutApi.md b/gooddata-api-client/docs/LayoutApi.md index fddb78141..081b5a573 100644 --- a/gooddata-api-client/docs/LayoutApi.md +++ b/gooddata-api-client/docs/LayoutApi.md @@ -2668,6 +2668,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], ), + interval="DAY", trigger="ALWAYS", ), analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -2735,7 +2736,16 @@ with gooddata_api_client.ApiClient() as api_client: ), ), ], - metadata=AutomationMetadata(), + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", @@ -2963,7 +2973,9 @@ with gooddata_api_client.ApiClient() as api_client: declarative_custom_geo_collections = DeclarativeCustomGeoCollections( custom_geo_collections=[ DeclarativeCustomGeoCollection( + description="description_example", id="my-geo-collection", + name="My Geo Collection", ), ], ) # DeclarativeCustomGeoCollections | @@ -3752,7 +3764,9 @@ with gooddata_api_client.ApiClient() as api_client: declarative_organization = DeclarativeOrganization( custom_geo_collections=[ DeclarativeCustomGeoCollection( + description="description_example", id="my-geo-collection", + name="My Geo Collection", ), ], data_sources=[ @@ -4074,6 +4088,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], ), + interval="DAY", trigger="ALWAYS", ), analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -4141,7 +4156,16 @@ with gooddata_api_client.ApiClient() as api_client: ), ), ], - metadata=AutomationMetadata(), + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", @@ -4304,7 +4328,7 @@ with gooddata_api_client.ApiClient() as api_client: custom_application_settings=[ DeclarativeCustomApplicationSetting( application_name="Modeler", - content=JsonNode(), + content={}, id="modeler.demo", ), ], @@ -5352,6 +5376,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], ), + interval="DAY", trigger="ALWAYS", ), analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -5419,7 +5444,16 @@ with gooddata_api_client.ApiClient() as api_client: ), ), ], - metadata=AutomationMetadata(), + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", @@ -5582,7 +5616,7 @@ with gooddata_api_client.ApiClient() as api_client: custom_application_settings=[ DeclarativeCustomApplicationSetting( application_name="Modeler", - content=JsonNode(), + content={}, id="modeler.demo", ), ], diff --git a/gooddata-api-client/docs/Notes.md b/gooddata-api-client/docs/Notes.md index eff8235b9..3ed862a5b 100644 --- a/gooddata-api-client/docs/Notes.md +++ b/gooddata-api-client/docs/Notes.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**note** | [**[Note]**](Note.md) | | [optional] +**note** | [**[Note]**](Note.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/OrganizationDeclarativeAPIsApi.md b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md index 7930d6c39..e379acbf4 100644 --- a/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md @@ -173,7 +173,9 @@ with gooddata_api_client.ApiClient() as api_client: declarative_custom_geo_collections = DeclarativeCustomGeoCollections( custom_geo_collections=[ DeclarativeCustomGeoCollection( + description="description_example", id="my-geo-collection", + name="My Geo Collection", ), ], ) # DeclarativeCustomGeoCollections | @@ -245,7 +247,9 @@ with gooddata_api_client.ApiClient() as api_client: declarative_organization = DeclarativeOrganization( custom_geo_collections=[ DeclarativeCustomGeoCollection( + description="description_example", id="my-geo-collection", + name="My Geo Collection", ), ], data_sources=[ @@ -567,6 +571,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], ), + interval="DAY", trigger="ALWAYS", ), analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -634,7 +639,16 @@ with gooddata_api_client.ApiClient() as api_client: ), ), ], - metadata=AutomationMetadata(), + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", @@ -797,7 +811,7 @@ with gooddata_api_client.ApiClient() as api_client: custom_application_settings=[ DeclarativeCustomApplicationSetting( application_name="Modeler", - content=JsonNode(), + content={}, id="modeler.demo", ), ], diff --git a/gooddata-api-client/docs/OrganizationModelControllerApi.md b/gooddata-api-client/docs/OrganizationModelControllerApi.md index 858b89dcb..df236457c 100644 --- a/gooddata-api-client/docs/OrganizationModelControllerApi.md +++ b/gooddata-api-client/docs/OrganizationModelControllerApi.md @@ -279,6 +279,10 @@ with gooddata_api_client.ApiClient() as api_client: 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", ), @@ -1305,7 +1309,7 @@ with gooddata_api_client.ApiClient() as api_client: "parent", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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=config,permissions,hierarchy,dataModelDatasets,all", + "metaInclude=permissions,config,hierarchy,dataModelDatasets,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -1530,7 +1534,7 @@ 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 = "" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: @@ -2570,7 +2574,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 = "" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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) 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 = [ @@ -3770,7 +3774,7 @@ with gooddata_api_client.ApiClient() as api_client: "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=config,permissions,hierarchy,dataModelDatasets,page,all", + "metaInclude=permissions,config,hierarchy,dataModelDatasets,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -3997,7 +4001,7 @@ 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 = "" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: @@ -5168,7 +5172,7 @@ with gooddata_api_client.ApiClient() as api_client: "parent", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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=config,permissions,hierarchy,dataModelDatasets,all", + "metaInclude=permissions,config,hierarchy,dataModelDatasets,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -5429,11 +5433,15 @@ with gooddata_api_client.ApiClient() as 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 = "" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: @@ -6825,11 +6833,15 @@ with gooddata_api_client.ApiClient() as 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 = "" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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: diff --git a/gooddata-api-client/docs/RelativeDateFilterRelativeDateFilter.md b/gooddata-api-client/docs/RelativeDateFilterRelativeDateFilter.md index 3c3e07a14..eca210716 100644 --- a/gooddata-api-client/docs/RelativeDateFilterRelativeDateFilter.md +++ b/gooddata-api-client/docs/RelativeDateFilterRelativeDateFilter.md @@ -10,7 +10,6 @@ Name | Type | Description | Notes **to** | **int** | End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). | **apply_on_result** | **bool** | | [optional] **bounded_filter** | [**BoundedFilter**](BoundedFilter.md) | | [optional] -**include_empty_values** | **bool** | If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition). | [optional] **local_identifier** | **str** | | [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/TestResponse.md b/gooddata-api-client/docs/TestResponse.md index 1bc06923c..8fbd3139f 100644 --- a/gooddata-api-client/docs/TestResponse.md +++ b/gooddata-api-client/docs/TestResponse.md @@ -1,6 +1,6 @@ # TestResponse -Response from data source testing. +Response from notification channel testing. ## Properties Name | Type | Description | Notes diff --git a/gooddata-api-client/docs/WorkspaceObjectControllerApi.md b/gooddata-api-client/docs/WorkspaceObjectControllerApi.md index 530fbd324..69a4b2195 100644 --- a/gooddata-api-client/docs/WorkspaceObjectControllerApi.md +++ b/gooddata-api-client/docs/WorkspaceObjectControllerApi.md @@ -398,6 +398,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], ), + interval="DAY", trigger="ALWAYS", ), are_relations_valid=True, @@ -448,7 +449,16 @@ with gooddata_api_client.ApiClient() as api_client: ), ), ], - metadata=JsonApiAutomationInAttributesMetadata(), + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), raw_exports=[ JsonApiAutomationInAttributesRawExportsInner( request_payload=RawExportAutomationRequest( @@ -7394,6 +7404,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], ), + interval="DAY", trigger="ALWAYS", ), are_relations_valid=True, @@ -7444,7 +7455,16 @@ with gooddata_api_client.ApiClient() as api_client: ), ), ], - metadata=JsonApiAutomationInAttributesMetadata(), + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), raw_exports=[ JsonApiAutomationInAttributesRawExportsInner( request_payload=RawExportAutomationRequest( @@ -11728,6 +11748,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], ), + interval="DAY", trigger="ALWAYS", ), are_relations_valid=True, @@ -11778,7 +11799,16 @@ with gooddata_api_client.ApiClient() as api_client: ), ), ], - metadata=JsonApiAutomationInAttributesMetadata(), + metadata=JsonApiAutomationInAttributesMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), raw_exports=[ JsonApiAutomationInAttributesRawExportsInner( request_payload=RawExportAutomationRequest( diff --git a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md index beb8c6433..2830e3aa8 100644 --- a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md @@ -656,6 +656,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ], ), + interval="DAY", trigger="ALWAYS", ), analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -723,7 +724,16 @@ with gooddata_api_client.ApiClient() as api_client: ), ), ], - metadata=AutomationMetadata(), + metadata=AutomationMetadata( + visible_filters=[ + VisibleFilter( + is_all_time_date_filter=False, + local_identifier="local_identifier_example", + title="title_example", + ), + ], + widget="widget_example", + ), modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", @@ -886,7 +896,7 @@ with gooddata_api_client.ApiClient() as api_client: custom_application_settings=[ DeclarativeCustomApplicationSetting( application_name="Modeler", - content=JsonNode(), + content={}, id="modeler.demo", ), ], diff --git a/gooddata-api-client/docs/WorkspacesEntityAPIsApi.md b/gooddata-api-client/docs/WorkspacesEntityAPIsApi.md index cf7b7f3a6..7871c39a0 100644 --- a/gooddata-api-client/docs/WorkspacesEntityAPIsApi.md +++ b/gooddata-api-client/docs/WorkspacesEntityAPIsApi.md @@ -71,7 +71,7 @@ with gooddata_api_client.ApiClient() as api_client: "parent", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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=config,permissions,hierarchy,dataModelDatasets,all", + "metaInclude=permissions,config,hierarchy,dataModelDatasets,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -235,7 +235,7 @@ with gooddata_api_client.ApiClient() as api_client: "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=config,permissions,hierarchy,dataModelDatasets,page,all", + "metaInclude=permissions,config,hierarchy,dataModelDatasets,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -315,7 +315,7 @@ with gooddata_api_client.ApiClient() as api_client: "parent", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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=config,permissions,hierarchy,dataModelDatasets,all", + "metaInclude=permissions,config,hierarchy,dataModelDatasets,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set diff --git a/gooddata-api-client/docs/Xliff.md b/gooddata-api-client/docs/Xliff.md index 6bfea0d90..6bdde8c9a 100644 --- a/gooddata-api-client/docs/Xliff.md +++ b/gooddata-api-client/docs/Xliff.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**file** | [**[File]**](File.md) | | [optional] +**file** | [**[File]**](File.md) | | **other_attributes** | **{str: (str,)}** | | [optional] **space** | **str** | | [optional] **src_lang** | **str** | | [optional] 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 352992ed7..85694c7b4 100644 --- a/gooddata-api-client/gooddata_api_client/api/entities_api.py +++ b/gooddata-api-client/gooddata_api_client/api/entities_api.py @@ -2501,8 +2501,8 @@ def __init__(self, api_client=None): }, ('meta_include',): { - "CONFIG": "config", "PERMISSIONS": "permissions", + "CONFIG": "config", "HIERARCHY": "hierarchy", "DATAMODELDATASETS": "dataModelDatasets", "ALL": "all", @@ -8691,8 +8691,8 @@ def __init__(self, api_client=None): }, ('meta_include',): { - "CONFIG": "config", "PERMISSIONS": "permissions", + "CONFIG": "config", "HIERARCHY": "hierarchy", "DATAMODELDATASETS": "dataModelDatasets", "PAGE": "page", @@ -12323,8 +12323,8 @@ def __init__(self, api_client=None): }, ('meta_include',): { - "CONFIG": "config", "PERMISSIONS": "permissions", + "CONFIG": "config", "HIERARCHY": "hierarchy", "DATAMODELDATASETS": "dataModelDatasets", "ALL": "all", 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 86caf1455..6090b74af 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 @@ -862,8 +862,8 @@ def __init__(self, api_client=None): }, ('meta_include',): { - "CONFIG": "config", "PERMISSIONS": "permissions", + "CONFIG": "config", "HIERARCHY": "hierarchy", "DATAMODELDATASETS": "dataModelDatasets", "ALL": "all", @@ -3178,8 +3178,8 @@ def __init__(self, api_client=None): }, ('meta_include',): { - "CONFIG": "config", "PERMISSIONS": "permissions", + "CONFIG": "config", "HIERARCHY": "hierarchy", "DATAMODELDATASETS": "dataModelDatasets", "PAGE": "page", @@ -4396,8 +4396,8 @@ def __init__(self, api_client=None): }, ('meta_include',): { - "CONFIG": "config", "PERMISSIONS": "permissions", + "CONFIG": "config", "HIERARCHY": "hierarchy", "DATAMODELDATASETS": "dataModelDatasets", "ALL": "all", diff --git a/gooddata-api-client/gooddata_api_client/api/workspaces_entity_apis_api.py b/gooddata-api-client/gooddata_api_client/api/workspaces_entity_apis_api.py index f43401a9a..4e361f4dd 100644 --- a/gooddata-api-client/gooddata_api_client/api/workspaces_entity_apis_api.py +++ b/gooddata-api-client/gooddata_api_client/api/workspaces_entity_apis_api.py @@ -82,8 +82,8 @@ def __init__(self, api_client=None): }, ('meta_include',): { - "CONFIG": "config", "PERMISSIONS": "permissions", + "CONFIG": "config", "HIERARCHY": "hierarchy", "DATAMODELDATASETS": "dataModelDatasets", "ALL": "all", @@ -227,8 +227,8 @@ def __init__(self, api_client=None): }, ('meta_include',): { - "CONFIG": "config", "PERMISSIONS": "permissions", + "CONFIG": "config", "HIERARCHY": "hierarchy", "DATAMODELDATASETS": "dataModelDatasets", "PAGE": "page", @@ -332,8 +332,8 @@ def __init__(self, api_client=None): }, ('meta_include',): { - "CONFIG": "config", "PERMISSIONS": "permissions", + "CONFIG": "config", "HIERARCHY": "hierarchy", "DATAMODELDATASETS": "dataModelDatasets", "ALL": "all", diff --git a/gooddata-api-client/gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py b/gooddata-api-client/gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py index 0c1811522..5dbd388ec 100644 --- a/gooddata-api-client/gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py @@ -102,7 +102,6 @@ def openapi_types(): '_from': (str,), # noqa: E501 'to': (str,), # noqa: E501 'apply_on_result': (bool,), # noqa: E501 - 'include_empty_values': (bool,), # noqa: E501 'local_identifier': (str,), # noqa: E501 } @@ -116,7 +115,6 @@ def discriminator(): '_from': 'from', # noqa: E501 'to': 'to', # noqa: E501 'apply_on_result': 'applyOnResult', # noqa: E501 - 'include_empty_values': 'includeEmptyValues', # noqa: E501 'local_identifier': 'localIdentifier', # noqa: E501 } @@ -167,7 +165,6 @@ def _from_openapi_data(cls, dataset, _from, to, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) apply_on_result (bool): [optional] # noqa: E501 - include_empty_values (bool): If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).. [optional] # noqa: E501 local_identifier (str): [optional] # noqa: E501 """ @@ -263,7 +260,6 @@ def __init__(self, dataset, _from, to, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) apply_on_result (bool): [optional] # noqa: E501 - include_empty_values (bool): If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).. [optional] # noqa: E501 local_identifier (str): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/automation_alert.py b/gooddata-api-client/gooddata_api_client/model/automation_alert.py index 6c9b2952d..23b982a90 100644 --- a/gooddata-api-client/gooddata_api_client/model/automation_alert.py +++ b/gooddata-api-client/gooddata_api_client/model/automation_alert.py @@ -62,9 +62,17 @@ class AutomationAlert(ModelNormal): """ allowed_values = { + ('interval',): { + 'DAY': "DAY", + 'WEEK': "WEEK", + 'MONTH': "MONTH", + 'QUARTER': "QUARTER", + 'YEAR': "YEAR", + }, ('trigger',): { 'ALWAYS': "ALWAYS", 'ONCE': "ONCE", + 'ONCE_PER_INTERVAL': "ONCE_PER_INTERVAL", }, } @@ -96,6 +104,7 @@ def openapi_types(): return { 'condition': (AutomationAlertCondition,), # noqa: E501 'execution': (AlertAfm,), # noqa: E501 + 'interval': (str,), # noqa: E501 'trigger': (str,), # noqa: E501 } @@ -107,6 +116,7 @@ def discriminator(): attribute_map = { 'condition': 'condition', # noqa: E501 'execution': 'execution', # noqa: E501 + 'interval': 'interval', # noqa: E501 'trigger': 'trigger', # noqa: E501 } @@ -155,7 +165,8 @@ def _from_openapi_data(cls, condition, execution, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - trigger (str): Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. . [optional] if omitted the server will use the default value of "ALWAYS" # noqa: E501 + interval (str): Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.. [optional] # noqa: E501 + trigger (str): Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS. . [optional] if omitted the server will use the default value of "ALWAYS" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,7 +258,8 @@ def __init__(self, condition, execution, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - trigger (str): Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. . [optional] if omitted the server will use the default value of "ALWAYS" # noqa: E501 + interval (str): Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.. [optional] # noqa: E501 + trigger (str): Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS. . [optional] if omitted the server will use the default value of "ALWAYS" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) 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 0cd15601f..d3c3f8b0d 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 @@ -130,7 +130,6 @@ def openapi_types(): 'bounded_filter': (RelativeBoundedDateFilter,), # noqa: E501 'data_set': (IdentifierRef,), # noqa: E501 '_from': (AacDashboardFilterFrom,), # noqa: E501 - 'include_empty_values': (bool,), # noqa: E501 'local_identifier': (str,), # noqa: E501 'to': (AacDashboardFilterFrom,), # noqa: E501 } @@ -147,7 +146,6 @@ def discriminator(): 'bounded_filter': 'boundedFilter', # noqa: E501 'data_set': 'dataSet', # noqa: E501 '_from': 'from', # noqa: E501 - 'include_empty_values': 'includeEmptyValues', # noqa: E501 'local_identifier': 'localIdentifier', # noqa: E501 'to': 'to', # noqa: E501 } @@ -201,7 +199,6 @@ def _from_openapi_data(cls, granularity, type, *args, **kwargs): # noqa: E501 bounded_filter (RelativeBoundedDateFilter): [optional] # noqa: E501 data_set (IdentifierRef): [optional] # noqa: E501 _from (AacDashboardFilterFrom): [optional] # noqa: E501 - include_empty_values (bool): [optional] # noqa: E501 local_identifier (str): [optional] # noqa: E501 to (AacDashboardFilterFrom): [optional] # noqa: E501 """ @@ -299,7 +296,6 @@ def __init__(self, granularity, type, *args, **kwargs): # noqa: E501 bounded_filter (RelativeBoundedDateFilter): [optional] # noqa: E501 data_set (IdentifierRef): [optional] # noqa: E501 _from (AacDashboardFilterFrom): [optional] # noqa: E501 - include_empty_values (bool): [optional] # noqa: E501 local_identifier (str): [optional] # noqa: E501 to (AacDashboardFilterFrom): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_column.py b/gooddata-api-client/gooddata_api_client/model/declarative_column.py index 51a442ff4..744dfe2ef 100644 Binary files a/gooddata-api-client/gooddata_api_client/model/declarative_column.py and b/gooddata-api-client/gooddata_api_client/model/declarative_column.py differ diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_custom_application_setting.py b/gooddata-api-client/gooddata_api_client/model/declarative_custom_application_setting.py index ff391768b..a156f5b6f 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_custom_application_setting.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_custom_application_setting.py @@ -30,10 +30,6 @@ from gooddata_api_client.exceptions import ApiAttributeError -def lazy_import(): - from gooddata_api_client.model.json_node import JsonNode - globals()['JsonNode'] = JsonNode - class DeclarativeCustomApplicationSetting(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. @@ -66,6 +62,8 @@ class DeclarativeCustomApplicationSetting(ModelNormal): ('application_name',): { 'max_length': 255, }, + ('content',): { + }, ('id',): { 'regex': { 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 @@ -79,7 +77,6 @@ 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 @@ -94,10 +91,9 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ - lazy_import() return { 'application_name': (str,), # noqa: E501 - 'content': (JsonNode,), # noqa: E501 + 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501 'id': (str,), # noqa: E501 } @@ -124,7 +120,7 @@ def _from_openapi_data(cls, application_name, content, id, *args, **kwargs): # Args: application_name (str): The application id - content (JsonNode): + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Free-form JSON content. Maximum supported length is 250000 characters. id (str): Custom Application Setting ID. Keyword Args: @@ -217,7 +213,7 @@ def __init__(self, application_name, content, id, *args, **kwargs): # noqa: E50 Args: application_name (str): The application id - content (JsonNode): + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Free-form JSON content. Maximum supported length is 250000 characters. id (str): Custom Application Setting ID. Keyword Args: diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_custom_geo_collection.py b/gooddata-api-client/gooddata_api_client/model/declarative_custom_geo_collection.py index dabf49a8e..4da3bf21a 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_custom_geo_collection.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_custom_geo_collection.py @@ -64,6 +64,12 @@ class DeclarativeCustomGeoCollection(ModelNormal): 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 }, }, + ('description',): { + 'max_length': 10000, + }, + ('name',): { + 'max_length': 255, + }, } @cached_property @@ -88,6 +94,8 @@ def openapi_types(): """ return { 'id': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 } @cached_property @@ -97,6 +105,8 @@ def discriminator(): attribute_map = { 'id': 'id', # noqa: E501 + 'description': 'description', # noqa: E501 + 'name': 'name', # noqa: E501 } read_only_vars = { @@ -143,6 +153,8 @@ def _from_openapi_data(cls, 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,) + description (str): Description of the custom geo collection.. [optional] # noqa: E501 + name (str): Name of the custom geo collection.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -232,6 +244,8 @@ def __init__(self, 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,) + description (str): Description of the custom geo collection.. [optional] # noqa: E501 + name (str): Name of the custom geo collection.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_data_source.py b/gooddata-api-client/gooddata_api_client/model/declarative_data_source.py index 279faa7c0..5afb19488 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_data_source.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_data_source.py @@ -90,6 +90,7 @@ class DeclarativeDataSource(ModelNormal): 'ATHENA': "ATHENA", 'MONGODB': "MONGODB", 'CRATEDB': "CRATEDB", + 'AILAKEHOUSE': "AILAKEHOUSE", }, ('authentication_type',): { 'None': None, diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_attributes.py index 18465d68b..55ee43194 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_attributes.py @@ -59,9 +59,19 @@ class JsonApiAnalyticalDashboardOutAttributes(ModelNormal): } validations = { + ('created_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('description',): { 'max_length': 10000, }, + ('modified_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('summary',): { 'max_length': 10000, }, @@ -93,9 +103,9 @@ def openapi_types(): return { 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 'are_relations_valid': (bool,), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 'description': (str,), # noqa: E501 - 'modified_at': (datetime,), # noqa: E501 + 'modified_at': (datetime, none_type,), # noqa: E501 'summary': (str,), # noqa: E501 'tags': ([str],), # noqa: E501 'title': (str,), # noqa: E501 @@ -162,9 +172,9 @@ def _from_openapi_data(cls, content, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 summary (str): AI-generated summary of the dashboard content. [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 @@ -258,9 +268,9 @@ def __init__(self, content, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 summary (str): AI-generated summary of the dashboard content. [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_attributes.py index 1123140ec..a4fba2fd5 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_attributes.py @@ -59,9 +59,19 @@ class JsonApiAttributeHierarchyOutAttributes(ModelNormal): } validations = { + ('created_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('description',): { 'max_length': 10000, }, + ('modified_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('title',): { 'max_length': 255, }, @@ -90,9 +100,9 @@ def openapi_types(): return { 'are_relations_valid': (bool,), # noqa: E501 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 'description': (str,), # noqa: E501 - 'modified_at': (datetime,), # noqa: E501 + 'modified_at': (datetime, none_type,), # noqa: E501 'tags': ([str],), # noqa: E501 'title': (str,), # noqa: E501 } @@ -155,9 +165,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters.. [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 """ @@ -247,9 +257,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters.. [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_alert.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_alert.py index 98df186e7..ce4717bd2 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_alert.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_alert.py @@ -62,9 +62,17 @@ class JsonApiAutomationInAttributesAlert(ModelNormal): """ allowed_values = { + ('interval',): { + 'DAY': "DAY", + 'WEEK': "WEEK", + 'MONTH': "MONTH", + 'QUARTER': "QUARTER", + 'YEAR': "YEAR", + }, ('trigger',): { 'ALWAYS': "ALWAYS", 'ONCE': "ONCE", + 'ONCE_PER_INTERVAL': "ONCE_PER_INTERVAL", }, } @@ -96,6 +104,7 @@ def openapi_types(): return { 'condition': (AlertCondition,), # noqa: E501 'execution': (AlertAfm,), # noqa: E501 + 'interval': (str,), # noqa: E501 'trigger': (str,), # noqa: E501 } @@ -107,6 +116,7 @@ def discriminator(): attribute_map = { 'condition': 'condition', # noqa: E501 'execution': 'execution', # noqa: E501 + 'interval': 'interval', # noqa: E501 'trigger': 'trigger', # noqa: E501 } @@ -155,7 +165,8 @@ def _from_openapi_data(cls, condition, execution, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - trigger (str): Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. . [optional] if omitted the server will use the default value of "ALWAYS" # noqa: E501 + interval (str): Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.. [optional] # noqa: E501 + trigger (str): Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS. . [optional] if omitted the server will use the default value of "ALWAYS" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,7 +258,8 @@ def __init__(self, condition, execution, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - trigger (str): Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. . [optional] if omitted the server will use the default value of "ALWAYS" # noqa: E501 + interval (str): Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.. [optional] # noqa: E501 + trigger (str): Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS. . [optional] if omitted the server will use the default value of "ALWAYS" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_attributes.py index deddc63ca..b652104c0 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_attributes.py @@ -89,11 +89,21 @@ class JsonApiAutomationOutAttributes(ModelNormal): } validations = { + ('created_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('description',): { 'max_length': 10000, }, ('details',): { }, + ('modified_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('title',): { 'max_length': 255, }, @@ -124,7 +134,7 @@ def openapi_types(): return { 'alert': (JsonApiAutomationInAttributesAlert,), # noqa: E501 'are_relations_valid': (bool,), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 'dashboard_tabular_exports': ([JsonApiAutomationInAttributesDashboardTabularExportsInner],), # noqa: E501 'description': (str,), # noqa: E501 'details': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 @@ -132,7 +142,7 @@ def openapi_types(): 'external_recipients': ([JsonApiAutomationInAttributesExternalRecipientsInner],), # noqa: E501 'image_exports': ([JsonApiAutomationInAttributesImageExportsInner],), # noqa: E501 'metadata': (JsonApiAutomationInAttributesMetadata,), # noqa: E501 - 'modified_at': (datetime,), # noqa: E501 + 'modified_at': (datetime, none_type,), # noqa: E501 'raw_exports': ([JsonApiAutomationInAttributesRawExportsInner],), # noqa: E501 'schedule': (JsonApiAutomationInAttributesSchedule,), # noqa: E501 'slides_exports': ([JsonApiAutomationInAttributesSlidesExportsInner],), # noqa: E501 @@ -213,7 +223,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) alert (JsonApiAutomationInAttributesAlert): [optional] # noqa: E501 are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 dashboard_tabular_exports ([JsonApiAutomationInAttributesDashboardTabularExportsInner]): [optional] # noqa: E501 description (str): [optional] # noqa: E501 details ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Additional details to be included in the automated message.. [optional] # noqa: E501 @@ -221,7 +231,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 external_recipients ([JsonApiAutomationInAttributesExternalRecipientsInner]): External recipients of the automation action results.. [optional] # noqa: E501 image_exports ([JsonApiAutomationInAttributesImageExportsInner]): [optional] # noqa: E501 metadata (JsonApiAutomationInAttributesMetadata): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 raw_exports ([JsonApiAutomationInAttributesRawExportsInner]): [optional] # noqa: E501 schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 slides_exports ([JsonApiAutomationInAttributesSlidesExportsInner]): [optional] # noqa: E501 @@ -317,7 +327,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) alert (JsonApiAutomationInAttributesAlert): [optional] # noqa: E501 are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 dashboard_tabular_exports ([JsonApiAutomationInAttributesDashboardTabularExportsInner]): [optional] # noqa: E501 description (str): [optional] # noqa: E501 details ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Additional details to be included in the automated message.. [optional] # noqa: E501 @@ -325,7 +335,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 external_recipients ([JsonApiAutomationInAttributesExternalRecipientsInner]): External recipients of the automation action results.. [optional] # noqa: E501 image_exports ([JsonApiAutomationInAttributesImageExportsInner]): [optional] # noqa: E501 metadata (JsonApiAutomationInAttributesMetadata): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 raw_exports ([JsonApiAutomationInAttributesRawExportsInner]): [optional] # noqa: E501 schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 slides_exports ([JsonApiAutomationInAttributesSlidesExportsInner]): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_in_attributes.py index 2157ea282..47b68897e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_in_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_in_attributes.py @@ -111,7 +111,7 @@ def _from_openapi_data(cls, application_name, content, *args, **kwargs): # noqa Args: application_name (str): - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters. + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -202,7 +202,7 @@ def __init__(self, application_name, content, *args, **kwargs): # noqa: E501 Args: application_name (str): - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters. + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters. 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_custom_application_setting_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_patch_attributes.py index 4374dc16d..475195073 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_patch_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_patch_attributes.py @@ -141,7 +141,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) application_name (str): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters.. [optional] # noqa: E501 + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -228,7 +228,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) application_name (str): [optional] # noqa: E501 - content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters.. [optional] # noqa: E501 + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_in.py index 29203c292..b1ee6fa2d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_in.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_in.py @@ -30,6 +30,10 @@ from gooddata_api_client.exceptions import ApiAttributeError +def lazy_import(): + from gooddata_api_client.model.json_api_custom_geo_collection_in_attributes import JsonApiCustomGeoCollectionInAttributes + globals()['JsonApiCustomGeoCollectionInAttributes'] = JsonApiCustomGeoCollectionInAttributes + class JsonApiCustomGeoCollectionIn(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. @@ -75,6 +79,7 @@ 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 @@ -89,9 +94,11 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 + 'attributes': (JsonApiCustomGeoCollectionInAttributes,), # noqa: E501 } @cached_property @@ -102,6 +109,7 @@ def discriminator(): attribute_map = { 'id': 'id', # noqa: E501 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 } read_only_vars = { @@ -149,6 +157,7 @@ def _from_openapi_data(cls, 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 (JsonApiCustomGeoCollectionInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "customGeoCollection") @@ -241,6 +250,7 @@ def __init__(self, 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 (JsonApiCustomGeoCollectionInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "customGeoCollection") diff --git a/gooddata-api-client/gooddata_api_client/model/array.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_in_attributes.py similarity index 77% rename from gooddata-api-client/gooddata_api_client/model/array.py rename to gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_in_attributes.py index de7b144a8..fcd932cf8 100644 --- a/gooddata-api-client/gooddata_api_client/model/array.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_in_attributes.py @@ -31,7 +31,7 @@ -class Array(ModelSimple): +class JsonApiCustomGeoCollectionInAttributes(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -42,6 +42,10 @@ class Array(ModelSimple): 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, @@ -55,9 +59,21 @@ class Array(ModelSimple): } validations = { + ('description',): { + 'max_length': 10000, + }, + ('name',): { + 'max_length': 255, + }, } - additional_properties_type = None + @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 @@ -72,7 +88,8 @@ def openapi_types(): and the value is attribute type. """ return { - 'value': ([str],), + 'description': (str, none_type,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 } @cached_property @@ -80,32 +97,22 @@ def discriminator(): return None - attribute_map = {} - - read_only_vars = set() + attribute_map = { + 'description': 'description', # noqa: E501 + 'name': 'name', # noqa: E501 + } - _composed_schemas = None + read_only_vars = { + } - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) + _composed_schemas = {} + @classmethod @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): - """Array - a model defined in OpenAPI - - Note that value can be passed either in args or in kwargs, but not in both. - - Args: - args[0] ([str]): # noqa: E501 + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiCustomGeoCollectionInAttributes - a model defined in OpenAPI Keyword Args: - value ([str]): # noqa: E501 _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. @@ -136,27 +143,18 @@ def __init__(self, *args, **kwargs): Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + description (str, none_type): [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _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): @@ -177,29 +175,31 @@ def __init__(self, *args, **kwargs): self._path_to_item = _path_to_item self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): - """Array - a model defined in OpenAPI + 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 - Note that value can be passed either in args or in kwargs, but not in both. + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) - Args: - args[0] ([str]): # noqa: E501 + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """JsonApiCustomGeoCollectionInAttributes - a model defined in OpenAPI Keyword Args: - value ([str]): # noqa: E501 _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. @@ -230,26 +230,13 @@ def _from_openapi_data(cls, *args, **kwargs): Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + description (str, none_type): [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 """ - # required up here when default value is not given - _path_to_item = kwargs.pop('_path_to_item', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if 'value' in kwargs: - value = kwargs.pop('value') - elif args: - args = list(args) - value = args.pop(0) - else: - raise ApiTypeError( - "value is required, but not passed in args or kwargs and doesn't have default", - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) _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', ()) @@ -273,15 +260,15 @@ def _from_openapi_data(cls, *args, **kwargs): self._path_to_item = _path_to_item self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.value = value - if kwargs: - raise ApiTypeError( - "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( - kwargs, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - return self + 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_custom_geo_collection_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out.py index 45ce91f2f..b140bd269 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out.py @@ -30,6 +30,10 @@ from gooddata_api_client.exceptions import ApiAttributeError +def lazy_import(): + from gooddata_api_client.model.json_api_custom_geo_collection_in_attributes import JsonApiCustomGeoCollectionInAttributes + globals()['JsonApiCustomGeoCollectionInAttributes'] = JsonApiCustomGeoCollectionInAttributes + class JsonApiCustomGeoCollectionOut(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. @@ -75,6 +79,7 @@ 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 @@ -89,9 +94,11 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 + 'attributes': (JsonApiCustomGeoCollectionInAttributes,), # noqa: E501 } @cached_property @@ -102,6 +109,7 @@ def discriminator(): attribute_map = { 'id': 'id', # noqa: E501 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 } read_only_vars = { @@ -149,6 +157,7 @@ def _from_openapi_data(cls, 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 (JsonApiCustomGeoCollectionInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "customGeoCollection") @@ -241,6 +250,7 @@ def __init__(self, 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 (JsonApiCustomGeoCollectionInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "customGeoCollection") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out_with_links.py index ae0153830..7bd1eeb81 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out_with_links.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out_with_links.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_custom_geo_collection_in_attributes import JsonApiCustomGeoCollectionInAttributes from gooddata_api_client.model.json_api_custom_geo_collection_out import JsonApiCustomGeoCollectionOut from gooddata_api_client.model.object_links import ObjectLinks from gooddata_api_client.model.object_links_container import ObjectLinksContainer + globals()['JsonApiCustomGeoCollectionInAttributes'] = JsonApiCustomGeoCollectionInAttributes globals()['JsonApiCustomGeoCollectionOut'] = JsonApiCustomGeoCollectionOut globals()['ObjectLinks'] = ObjectLinks globals()['ObjectLinksContainer'] = ObjectLinksContainer @@ -102,6 +104,7 @@ def openapi_types(): return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 + 'attributes': (JsonApiCustomGeoCollectionInAttributes,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 } @@ -113,6 +116,7 @@ def discriminator(): attribute_map = { 'id': 'id', # noqa: E501 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 'links': 'links', # noqa: E501 } @@ -157,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 (JsonApiCustomGeoCollectionInAttributes): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ @@ -264,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 (JsonApiCustomGeoCollectionInAttributes): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_patch.py index c4a8dd146..f3da7c0df 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_patch.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_patch.py @@ -30,6 +30,10 @@ from gooddata_api_client.exceptions import ApiAttributeError +def lazy_import(): + from gooddata_api_client.model.json_api_custom_geo_collection_in_attributes import JsonApiCustomGeoCollectionInAttributes + globals()['JsonApiCustomGeoCollectionInAttributes'] = JsonApiCustomGeoCollectionInAttributes + class JsonApiCustomGeoCollectionPatch(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. @@ -75,6 +79,7 @@ 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 @@ -89,9 +94,11 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 + 'attributes': (JsonApiCustomGeoCollectionInAttributes,), # noqa: E501 } @cached_property @@ -102,6 +109,7 @@ def discriminator(): attribute_map = { 'id': 'id', # noqa: E501 'type': 'type', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 } read_only_vars = { @@ -149,6 +157,7 @@ def _from_openapi_data(cls, 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 (JsonApiCustomGeoCollectionInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "customGeoCollection") @@ -241,6 +250,7 @@ def __init__(self, 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 (JsonApiCustomGeoCollectionInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "customGeoCollection") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_attributes.py index f59569ad6..1dbf1bb4c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_attributes.py @@ -59,9 +59,19 @@ class JsonApiDashboardPluginOutAttributes(ModelNormal): } validations = { + ('created_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('description',): { 'max_length': 10000, }, + ('modified_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('title',): { 'max_length': 255, }, @@ -90,9 +100,9 @@ def openapi_types(): return { 'are_relations_valid': (bool,), # noqa: E501 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 'description': (str,), # noqa: E501 - 'modified_at': (datetime,), # noqa: E501 + 'modified_at': (datetime, none_type,), # noqa: E501 'tags': ([str],), # noqa: E501 'title': (str,), # noqa: E501 } @@ -155,9 +165,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters.. [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 """ @@ -247,9 +257,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters.. [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_attributes.py index 1bbc17657..4882472e7 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_attributes.py @@ -84,6 +84,7 @@ class JsonApiDataSourceIdentifierOutAttributes(ModelNormal): 'ATHENA': "ATHENA", 'MONGODB': "MONGODB", 'CRATEDB': "CRATEDB", + 'AILAKEHOUSE': "AILAKEHOUSE", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_attributes.py index 173e64043..9aa8d1d84 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_in_attributes.py @@ -88,6 +88,7 @@ class JsonApiDataSourceInAttributes(ModelNormal): 'ATHENA': "ATHENA", 'MONGODB': "MONGODB", 'CRATEDB': "CRATEDB", + 'AILAKEHOUSE': "AILAKEHOUSE", }, ('cache_strategy',): { 'None': None, diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_attributes.py index 8f53ee998..aafb6f290 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_attributes.py @@ -88,6 +88,7 @@ class JsonApiDataSourceOutAttributes(ModelNormal): 'ATHENA': "ATHENA", 'MONGODB': "MONGODB", 'CRATEDB': "CRATEDB", + 'AILAKEHOUSE': "AILAKEHOUSE", }, ('authentication_type',): { 'None': None, diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_attributes.py index d4412d816..cf1fc98b9 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_patch_attributes.py @@ -93,6 +93,7 @@ class JsonApiDataSourcePatchAttributes(ModelNormal): 'ATHENA': "ATHENA", 'MONGODB': "MONGODB", 'CRATEDB': "CRATEDB", + 'AILAKEHOUSE': "AILAKEHOUSE", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_attributes.py index 09e266d1f..4191efd69 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_attributes.py @@ -63,9 +63,19 @@ class JsonApiExportDefinitionOutAttributes(ModelNormal): } validations = { + ('created_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('description',): { 'max_length': 10000, }, + ('modified_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('title',): { 'max_length': 255, }, @@ -95,9 +105,9 @@ def openapi_types(): lazy_import() return { 'are_relations_valid': (bool,), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 'description': (str,), # noqa: E501 - 'modified_at': (datetime,), # noqa: E501 + 'modified_at': (datetime, none_type,), # noqa: E501 'request_payload': (JsonApiExportDefinitionInAttributesRequestPayload,), # noqa: E501 'tags': ([str],), # noqa: E501 'title': (str,), # noqa: E501 @@ -160,9 +170,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 request_payload (JsonApiExportDefinitionInAttributesRequestPayload): [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 @@ -252,9 +262,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 request_payload (JsonApiExportDefinitionInAttributesRequestPayload): [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes_content.py b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes_content.py index 3554ced2b..47aec8f18 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes_content.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_in_attributes_content.py @@ -74,6 +74,13 @@ class JsonApiJwkInAttributesContent(ModelComposed): } validations = { + ('kid',): { + 'max_length': 255, + 'min_length': 0, + 'regex': { + 'pattern': r'^[^.]', # noqa: E501 + }, + }, } @cached_property diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out_attributes.py index 402462862..6fafa1f19 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out_attributes.py @@ -66,9 +66,19 @@ class JsonApiMemoryItemOutAttributes(ModelNormal): ('instruction',): { 'max_length': 255, }, + ('created_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('description',): { 'max_length': 10000, }, + ('modified_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('title',): { 'max_length': 255, }, @@ -98,11 +108,11 @@ def openapi_types(): 'instruction': (str,), # noqa: E501 'strategy': (str,), # noqa: E501 'are_relations_valid': (bool,), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 'description': (str,), # noqa: E501 'is_disabled': (bool,), # noqa: E501 'keywords': ([str],), # noqa: E501 - 'modified_at': (datetime,), # noqa: E501 + 'modified_at': (datetime, none_type,), # noqa: E501 'tags': ([str],), # noqa: E501 'title': (str,), # noqa: E501 } @@ -171,11 +181,11 @@ def _from_openapi_data(cls, instruction, strategy, *args, **kwargs): # noqa: E5 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_disabled (bool): Whether memory item is disabled. [optional] # noqa: E501 keywords ([str]): Set of unique strings used for semantic similarity filtering. [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 """ @@ -270,11 +280,11 @@ def __init__(self, instruction, strategy, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_disabled (bool): Whether memory item is disabled. [optional] # noqa: E501 keywords ([str]): Set of unique strings used for semantic similarity filtering. [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_attributes.py index 0273d2709..83d497548 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_attributes.py @@ -63,9 +63,19 @@ class JsonApiMetricOutAttributes(ModelNormal): } validations = { + ('created_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('description',): { 'max_length': 10000, }, + ('modified_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('title',): { 'max_length': 255, }, @@ -96,11 +106,11 @@ def openapi_types(): return { 'content': (JsonApiMetricInAttributesContent,), # noqa: E501 'are_relations_valid': (bool,), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 'description': (str,), # noqa: E501 'is_hidden': (bool,), # noqa: E501 'is_hidden_from_kda': (bool,), # noqa: E501 - 'modified_at': (datetime,), # noqa: E501 + 'modified_at': (datetime, none_type,), # noqa: E501 'tags': ([str],), # noqa: E501 'title': (str,), # noqa: E501 } @@ -167,11 +177,11 @@ def _from_openapi_data(cls, content, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 is_hidden_from_kda (bool): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 """ @@ -264,11 +274,11 @@ def __init__(self, content, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 is_hidden_from_kda (bool): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_attributes.py index 9bf8d32a0..e0953d58e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_attributes.py @@ -59,9 +59,19 @@ class JsonApiVisualizationObjectOutAttributes(ModelNormal): } validations = { + ('created_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('description',): { 'max_length': 10000, }, + ('modified_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, ('title',): { 'max_length': 255, }, @@ -90,10 +100,10 @@ def openapi_types(): return { 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 'are_relations_valid': (bool,), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 'description': (str,), # noqa: E501 'is_hidden': (bool,), # noqa: E501 - 'modified_at': (datetime,), # noqa: E501 + 'modified_at': (datetime, none_type,), # noqa: E501 'tags': ([str],), # noqa: E501 'title': (str,), # noqa: E501 } @@ -159,10 +169,10 @@ def _from_openapi_data(cls, content, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 """ @@ -255,10 +265,10 @@ def __init__(self, content, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 - created_at (datetime): [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 - modified_at (datetime): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out.py index 46026361f..7967c7d45 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out.py @@ -31,9 +31,9 @@ def lazy_import(): - from gooddata_api_client.model.json_api_automation_out_attributes import JsonApiAutomationOutAttributes + from gooddata_api_client.model.json_api_workspace_automation_out_attributes import JsonApiWorkspaceAutomationOutAttributes from gooddata_api_client.model.json_api_workspace_automation_out_relationships import JsonApiWorkspaceAutomationOutRelationships - globals()['JsonApiAutomationOutAttributes'] = JsonApiAutomationOutAttributes + globals()['JsonApiWorkspaceAutomationOutAttributes'] = JsonApiWorkspaceAutomationOutAttributes globals()['JsonApiWorkspaceAutomationOutRelationships'] = JsonApiWorkspaceAutomationOutRelationships @@ -100,7 +100,7 @@ def openapi_types(): return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'attributes': (JsonApiAutomationOutAttributes,), # noqa: E501 + 'attributes': (JsonApiWorkspaceAutomationOutAttributes,), # noqa: E501 'relationships': (JsonApiWorkspaceAutomationOutRelationships,), # noqa: E501 } @@ -161,7 +161,7 @@ def _from_openapi_data(cls, 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 (JsonApiAutomationOutAttributes): [optional] # noqa: E501 + attributes (JsonApiWorkspaceAutomationOutAttributes): [optional] # noqa: E501 relationships (JsonApiWorkspaceAutomationOutRelationships): [optional] # noqa: E501 """ @@ -255,7 +255,7 @@ def __init__(self, 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 (JsonApiAutomationOutAttributes): [optional] # noqa: E501 + attributes (JsonApiWorkspaceAutomationOutAttributes): [optional] # noqa: E501 relationships (JsonApiWorkspaceAutomationOutRelationships): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_attributes.py new file mode 100644 index 000000000..6c0859e84 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_attributes.py @@ -0,0 +1,376 @@ +""" + 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_api_automation_in_attributes_alert import JsonApiAutomationInAttributesAlert + from gooddata_api_client.model.json_api_automation_in_attributes_dashboard_tabular_exports_inner import JsonApiAutomationInAttributesDashboardTabularExportsInner + from gooddata_api_client.model.json_api_automation_in_attributes_external_recipients_inner import JsonApiAutomationInAttributesExternalRecipientsInner + from gooddata_api_client.model.json_api_automation_in_attributes_image_exports_inner import JsonApiAutomationInAttributesImageExportsInner + from gooddata_api_client.model.json_api_automation_in_attributes_metadata import JsonApiAutomationInAttributesMetadata + from gooddata_api_client.model.json_api_automation_in_attributes_raw_exports_inner import JsonApiAutomationInAttributesRawExportsInner + from gooddata_api_client.model.json_api_automation_in_attributes_schedule import JsonApiAutomationInAttributesSchedule + from gooddata_api_client.model.json_api_automation_in_attributes_slides_exports_inner import JsonApiAutomationInAttributesSlidesExportsInner + from gooddata_api_client.model.json_api_automation_in_attributes_tabular_exports_inner import JsonApiAutomationInAttributesTabularExportsInner + from gooddata_api_client.model.json_api_automation_in_attributes_visual_exports_inner import JsonApiAutomationInAttributesVisualExportsInner + globals()['JsonApiAutomationInAttributesAlert'] = JsonApiAutomationInAttributesAlert + globals()['JsonApiAutomationInAttributesDashboardTabularExportsInner'] = JsonApiAutomationInAttributesDashboardTabularExportsInner + globals()['JsonApiAutomationInAttributesExternalRecipientsInner'] = JsonApiAutomationInAttributesExternalRecipientsInner + globals()['JsonApiAutomationInAttributesImageExportsInner'] = JsonApiAutomationInAttributesImageExportsInner + globals()['JsonApiAutomationInAttributesMetadata'] = JsonApiAutomationInAttributesMetadata + globals()['JsonApiAutomationInAttributesRawExportsInner'] = JsonApiAutomationInAttributesRawExportsInner + globals()['JsonApiAutomationInAttributesSchedule'] = JsonApiAutomationInAttributesSchedule + globals()['JsonApiAutomationInAttributesSlidesExportsInner'] = JsonApiAutomationInAttributesSlidesExportsInner + globals()['JsonApiAutomationInAttributesTabularExportsInner'] = JsonApiAutomationInAttributesTabularExportsInner + globals()['JsonApiAutomationInAttributesVisualExportsInner'] = JsonApiAutomationInAttributesVisualExportsInner + + +class JsonApiWorkspaceAutomationOutAttributes(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 = { + ('evaluation_mode',): { + 'SHARED': "SHARED", + 'PER_RECIPIENT': "PER_RECIPIENT", + }, + ('state',): { + 'ACTIVE': "ACTIVE", + 'PAUSED': "PAUSED", + }, + } + + validations = { + ('description',): { + 'max_length': 10000, + }, + ('details',): { + }, + ('title',): { + 'max_length': 255, + }, + } + + @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 { + 'alert': (JsonApiAutomationInAttributesAlert,), # noqa: E501 + 'are_relations_valid': (bool,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + 'dashboard_tabular_exports': ([JsonApiAutomationInAttributesDashboardTabularExportsInner],), # noqa: E501 + 'description': (str,), # noqa: E501 + 'details': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'evaluation_mode': (str,), # noqa: E501 + 'external_recipients': ([JsonApiAutomationInAttributesExternalRecipientsInner],), # noqa: E501 + 'image_exports': ([JsonApiAutomationInAttributesImageExportsInner],), # noqa: E501 + 'metadata': (JsonApiAutomationInAttributesMetadata,), # noqa: E501 + 'modified_at': (datetime,), # noqa: E501 + 'raw_exports': ([JsonApiAutomationInAttributesRawExportsInner],), # noqa: E501 + 'schedule': (JsonApiAutomationInAttributesSchedule,), # noqa: E501 + 'slides_exports': ([JsonApiAutomationInAttributesSlidesExportsInner],), # noqa: E501 + 'state': (str,), # noqa: E501 + 'tabular_exports': ([JsonApiAutomationInAttributesTabularExportsInner],), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'title': (str,), # noqa: E501 + 'visual_exports': ([JsonApiAutomationInAttributesVisualExportsInner],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'alert': 'alert', # noqa: E501 + 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'dashboard_tabular_exports': 'dashboardTabularExports', # noqa: E501 + 'description': 'description', # noqa: E501 + 'details': 'details', # noqa: E501 + 'evaluation_mode': 'evaluationMode', # noqa: E501 + 'external_recipients': 'externalRecipients', # noqa: E501 + 'image_exports': 'imageExports', # noqa: E501 + 'metadata': 'metadata', # noqa: E501 + 'modified_at': 'modifiedAt', # noqa: E501 + 'raw_exports': 'rawExports', # noqa: E501 + 'schedule': 'schedule', # noqa: E501 + 'slides_exports': 'slidesExports', # noqa: E501 + 'state': 'state', # noqa: E501 + 'tabular_exports': 'tabularExports', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'title': 'title', # noqa: E501 + 'visual_exports': 'visualExports', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiWorkspaceAutomationOutAttributes - 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,) + alert (JsonApiAutomationInAttributesAlert): [optional] # noqa: E501 + are_relations_valid (bool): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + dashboard_tabular_exports ([JsonApiAutomationInAttributesDashboardTabularExportsInner]): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + details ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Additional details to be included in the automated message.. [optional] # noqa: E501 + evaluation_mode (str): Specify automation evaluation mode.. [optional] # noqa: E501 + external_recipients ([JsonApiAutomationInAttributesExternalRecipientsInner]): External recipients of the automation action results.. [optional] # noqa: E501 + image_exports ([JsonApiAutomationInAttributesImageExportsInner]): [optional] # noqa: E501 + metadata (JsonApiAutomationInAttributesMetadata): [optional] # noqa: E501 + modified_at (datetime): [optional] # noqa: E501 + raw_exports ([JsonApiAutomationInAttributesRawExportsInner]): [optional] # noqa: E501 + schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 + slides_exports ([JsonApiAutomationInAttributesSlidesExportsInner]): [optional] # noqa: E501 + state (str): Current state of the automation.. [optional] # noqa: E501 + tabular_exports ([JsonApiAutomationInAttributesTabularExportsInner]): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + visual_exports ([JsonApiAutomationInAttributesVisualExportsInner]): [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 + """JsonApiWorkspaceAutomationOutAttributes - 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,) + alert (JsonApiAutomationInAttributesAlert): [optional] # noqa: E501 + are_relations_valid (bool): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + dashboard_tabular_exports ([JsonApiAutomationInAttributesDashboardTabularExportsInner]): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + details ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Additional details to be included in the automated message.. [optional] # noqa: E501 + evaluation_mode (str): Specify automation evaluation mode.. [optional] # noqa: E501 + external_recipients ([JsonApiAutomationInAttributesExternalRecipientsInner]): External recipients of the automation action results.. [optional] # noqa: E501 + image_exports ([JsonApiAutomationInAttributesImageExportsInner]): [optional] # noqa: E501 + metadata (JsonApiAutomationInAttributesMetadata): [optional] # noqa: E501 + modified_at (datetime): [optional] # noqa: E501 + raw_exports ([JsonApiAutomationInAttributesRawExportsInner]): [optional] # noqa: E501 + schedule (JsonApiAutomationInAttributesSchedule): [optional] # noqa: E501 + slides_exports ([JsonApiAutomationInAttributesSlidesExportsInner]): [optional] # noqa: E501 + state (str): Current state of the automation.. [optional] # noqa: E501 + tabular_exports ([JsonApiAutomationInAttributesTabularExportsInner]): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + visual_exports ([JsonApiAutomationInAttributesVisualExportsInner]): [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_workspace_automation_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_with_links.py index ab0244692..3c763bf77 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_with_links.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_automation_out_with_links.py @@ -31,13 +31,13 @@ def lazy_import(): - from gooddata_api_client.model.json_api_automation_out_attributes import JsonApiAutomationOutAttributes from gooddata_api_client.model.json_api_workspace_automation_out import JsonApiWorkspaceAutomationOut + from gooddata_api_client.model.json_api_workspace_automation_out_attributes import JsonApiWorkspaceAutomationOutAttributes from gooddata_api_client.model.json_api_workspace_automation_out_relationships import JsonApiWorkspaceAutomationOutRelationships from gooddata_api_client.model.object_links import ObjectLinks from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAutomationOutAttributes'] = JsonApiAutomationOutAttributes globals()['JsonApiWorkspaceAutomationOut'] = JsonApiWorkspaceAutomationOut + globals()['JsonApiWorkspaceAutomationOutAttributes'] = JsonApiWorkspaceAutomationOutAttributes globals()['JsonApiWorkspaceAutomationOutRelationships'] = JsonApiWorkspaceAutomationOutRelationships globals()['ObjectLinks'] = ObjectLinks globals()['ObjectLinksContainer'] = ObjectLinksContainer @@ -106,7 +106,7 @@ def openapi_types(): return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'attributes': (JsonApiAutomationOutAttributes,), # noqa: E501 + 'attributes': (JsonApiWorkspaceAutomationOutAttributes,), # noqa: E501 'relationships': (JsonApiWorkspaceAutomationOutRelationships,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 } @@ -165,7 +165,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 (JsonApiAutomationOutAttributes): [optional] # noqa: E501 + attributes (JsonApiWorkspaceAutomationOutAttributes): [optional] # noqa: E501 relationships (JsonApiWorkspaceAutomationOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ @@ -274,7 +274,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 (JsonApiAutomationOutAttributes): [optional] # noqa: E501 + attributes (JsonApiWorkspaceAutomationOutAttributes): [optional] # noqa: E501 relationships (JsonApiWorkspaceAutomationOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/notes.py b/gooddata-api-client/gooddata_api_client/model/notes.py index 9c91f4f85..e3e7b9e30 100644 --- a/gooddata-api-client/gooddata_api_client/model/notes.py +++ b/gooddata-api-client/gooddata_api_client/model/notes.py @@ -107,9 +107,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, note, *args, **kwargs): # noqa: E501 """Notes - a model defined in OpenAPI + Args: + note ([Note]): + Keyword Args: _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be @@ -141,7 +144,6 @@ 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,) - note ([Note]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -173,6 +175,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.note = note for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -193,9 +196,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 + def __init__(self, note, *args, **kwargs): # noqa: E501 """Notes - a model defined in OpenAPI + Args: + note ([Note]): + Keyword Args: _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be @@ -227,7 +233,6 @@ 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,) - note ([Note]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -257,6 +262,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.note = note 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/relative_date_filter_relative_date_filter.py b/gooddata-api-client/gooddata_api_client/model/relative_date_filter_relative_date_filter.py index 5c9e1e044..f15b1a387 100644 --- a/gooddata-api-client/gooddata_api_client/model/relative_date_filter_relative_date_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/relative_date_filter_relative_date_filter.py @@ -117,7 +117,6 @@ def openapi_types(): 'to': (int,), # noqa: E501 'apply_on_result': (bool,), # noqa: E501 'bounded_filter': (BoundedFilter,), # noqa: E501 - 'include_empty_values': (bool,), # noqa: E501 'local_identifier': (str,), # noqa: E501 } @@ -133,7 +132,6 @@ def discriminator(): 'to': 'to', # noqa: E501 'apply_on_result': 'applyOnResult', # noqa: E501 'bounded_filter': 'boundedFilter', # noqa: E501 - 'include_empty_values': 'includeEmptyValues', # noqa: E501 'local_identifier': 'localIdentifier', # noqa: E501 } @@ -186,7 +184,6 @@ def _from_openapi_data(cls, dataset, _from, granularity, to, *args, **kwargs): _visited_composed_classes = (Animal,) apply_on_result (bool): [optional] # noqa: E501 bounded_filter (BoundedFilter): [optional] # noqa: E501 - include_empty_values (bool): If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).. [optional] # noqa: E501 local_identifier (str): [optional] # noqa: E501 """ @@ -285,7 +282,6 @@ def __init__(self, dataset, _from, granularity, to, *args, **kwargs): # noqa: E _visited_composed_classes = (Animal,) apply_on_result (bool): [optional] # noqa: E501 bounded_filter (BoundedFilter): [optional] # noqa: E501 - include_empty_values (bool): If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).. [optional] # noqa: E501 local_identifier (str): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/rsa_specification.py b/gooddata-api-client/gooddata_api_client/model/rsa_specification.py index 26adabffc..e6283d481 100644 --- a/gooddata-api-client/gooddata_api_client/model/rsa_specification.py +++ b/gooddata-api-client/gooddata_api_client/model/rsa_specification.py @@ -70,6 +70,13 @@ class RsaSpecification(ModelNormal): } validations = { + ('kid',): { + 'max_length': 255, + 'min_length': 0, + 'regex': { + 'pattern': r'^[^.]', # noqa: E501 + }, + }, } @cached_property diff --git a/gooddata-api-client/gooddata_api_client/model/xliff.py b/gooddata-api-client/gooddata_api_client/model/xliff.py index 206e6ec6f..ab6600299 100644 --- a/gooddata-api-client/gooddata_api_client/model/xliff.py +++ b/gooddata-api-client/gooddata_api_client/model/xliff.py @@ -117,9 +117,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, file, *args, **kwargs): # noqa: E501 """Xliff - a model defined in OpenAPI + Args: + file ([File]): + Keyword Args: _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be @@ -151,7 +154,6 @@ 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,) - file ([File]): [optional] # noqa: E501 other_attributes ({str: (str,)}): [optional] # noqa: E501 space (str): [optional] # noqa: E501 src_lang (str): [optional] # noqa: E501 @@ -188,6 +190,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.file = file for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -208,9 +211,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 + def __init__(self, file, *args, **kwargs): # noqa: E501 """Xliff - a model defined in OpenAPI + Args: + file ([File]): + Keyword Args: _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be @@ -242,7 +248,6 @@ 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,) - file ([File]): [optional] # noqa: E501 other_attributes ({str: (str,)}): [optional] # noqa: E501 space (str): [optional] # noqa: E501 src_lang (str): [optional] # noqa: E501 @@ -277,6 +282,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.file = file 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/models/__init__.py b/gooddata-api-client/gooddata_api_client/models/__init__.py index fd33653b8..a4059d084 100644 --- a/gooddata-api-client/gooddata_api_client/models/__init__.py +++ b/gooddata-api-client/gooddata_api_client/models/__init__.py @@ -98,7 +98,6 @@ from gooddata_api_client.model.arithmetic_measure import ArithmeticMeasure from gooddata_api_client.model.arithmetic_measure_definition import ArithmeticMeasureDefinition from gooddata_api_client.model.arithmetic_measure_definition_arithmetic_measure import ArithmeticMeasureDefinitionArithmeticMeasure -from gooddata_api_client.model.array import Array from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier from gooddata_api_client.model.assignee_rule import AssigneeRule from gooddata_api_client.model.attribute_elements import AttributeElements @@ -517,6 +516,7 @@ from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id import JsonApiCustomApplicationSettingPostOptionalId from gooddata_api_client.model.json_api_custom_application_setting_post_optional_id_document import JsonApiCustomApplicationSettingPostOptionalIdDocument from gooddata_api_client.model.json_api_custom_geo_collection_in import JsonApiCustomGeoCollectionIn +from gooddata_api_client.model.json_api_custom_geo_collection_in_attributes import JsonApiCustomGeoCollectionInAttributes 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 import JsonApiCustomGeoCollectionOut from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument @@ -875,6 +875,7 @@ from gooddata_api_client.model.json_api_visualization_object_to_many_linkage import JsonApiVisualizationObjectToManyLinkage from gooddata_api_client.model.json_api_visualization_object_to_one_linkage import JsonApiVisualizationObjectToOneLinkage from gooddata_api_client.model.json_api_workspace_automation_out import JsonApiWorkspaceAutomationOut +from gooddata_api_client.model.json_api_workspace_automation_out_attributes import JsonApiWorkspaceAutomationOutAttributes from gooddata_api_client.model.json_api_workspace_automation_out_includes import JsonApiWorkspaceAutomationOutIncludes from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList from gooddata_api_client.model.json_api_workspace_automation_out_relationships import JsonApiWorkspaceAutomationOutRelationships diff --git a/schemas/gooddata-afm-client.json b/schemas/gooddata-afm-client.json index 232563de4..767db3e2b 100644 --- a/schemas/gooddata-afm-client.json +++ b/schemas/gooddata-afm-client.json @@ -1,6788 +1,5519 @@ { - "components": { - "schemas": { - "AFM": { - "description": "Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.", - "properties": { - "attributes": { - "description": "Attributes to be used in the computation.", - "items": { - "$ref": "#/components/schemas/AttributeItem" - }, - "type": "array" - }, - "auxMeasures": { - "description": "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "type": "array" - }, - "filters": { - "description": "Various filter types to filter the execution result.", - "items": { - "$ref": "#/components/schemas/FilterDefinition" - }, - "type": "array" - }, - "measures": { - "description": "Metrics to be computed.", - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "type": "array" - } - }, - "required": [ - "attributes", - "filters", - "measures" - ], - "type": "object" - }, - "AbsoluteDateFilter": { - "description": "A datetime filter specifying exact from and to values.", - "properties": { - "absoluteDateFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" + "components" : { + "schemas" : { + "AFM" : { + "description" : "Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.", + "properties" : { + "attributes" : { + "description" : "Attributes to be used in the computation.", + "items" : { + "$ref" : "#/components/schemas/AttributeItem" + }, + "type" : "array" + }, + "auxMeasures" : { + "description" : "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", + "items" : { + "$ref" : "#/components/schemas/MeasureItem" + }, + "type" : "array" + }, + "filters" : { + "description" : "Various filter types to filter the execution result.", + "items" : { + "$ref" : "#/components/schemas/FilterDefinition" + }, + "type" : "array" + }, + "measures" : { + "description" : "Metrics to be computed.", + "items" : { + "$ref" : "#/components/schemas/MeasureItem" + }, + "type" : "array" + } + }, + "required" : [ "attributes", "filters", "measures" ], + "type" : "object" + }, + "AbsoluteDateFilter" : { + "description" : "A datetime filter specifying exact from and to values.", + "properties" : { + "absoluteDateFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" }, - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" + "dataset" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierDataset" }, - "from": { - "example": "2020-07-01 18:23", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", - "type": "string" + "from" : { + "example" : "2020-07-01 18:23", + "pattern" : "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "type" : "string" }, - "includeEmptyValues": { - "description": "If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).", - "type": "boolean" + "localIdentifier" : { + "type" : "string" }, - "localIdentifier": { - "type": "string" - }, - "to": { - "example": "2020-07-16 23:59", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", - "type": "string" + "to" : { + "example" : "2020-07-16 23:59", + "pattern" : "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "type" : "string" } }, - "required": [ - "from", - "to", - "dataset" - ], - "type": "object" + "required" : [ "from", "to", "dataset" ], + "type" : "object" } }, - "required": [ - "absoluteDateFilter" - ], - "type": "object" - }, - "AbstractMeasureValueFilter": { - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/RangeMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/CompoundMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/RankingFilter" - } - ], - "type": "object" - }, - "ActiveObjectIdentification": { - "description": "Object, with which the user is actively working.", - "properties": { - "id": { - "description": "Object ID.", - "type": "string" - }, - "type": { - "description": "Object type, e.g. dashboard.", - "type": "string" - }, - "workspaceId": { - "description": "Workspace ID.", - "type": "string" - } - }, - "required": [ - "id", - "type", - "workspaceId" - ], - "type": "object" - }, - "AfmCancelTokens": { - "description": "Any information related to cancellation.", - "properties": { - "resultIdToCancelTokenPairs": { - "additionalProperties": { - "type": "string" - }, - "description": "resultId to cancel token pairs", - "type": "object" - } - }, - "required": [ - "resultIdToCancelTokenPairs" - ], - "type": "object" - }, - "AfmExecution": { - "properties": { - "execution": { - "$ref": "#/components/schemas/AFM" - }, - "resultSpec": { - "$ref": "#/components/schemas/ResultSpec" - }, - "settings": { - "$ref": "#/components/schemas/ExecutionSettings" - } - }, - "required": [ - "execution", - "resultSpec" - ], - "type": "object" - }, - "AfmExecutionResponse": { - "description": "Response to AFM execution request", - "properties": { - "executionResponse": { - "$ref": "#/components/schemas/ExecutionResponse" - } - }, - "required": [ - "executionResponse" - ], - "type": "object" - }, - "AfmIdentifier": { - "description": "Reference to the attribute label to which the filter should be applied.", - "oneOf": [ - { - "$ref": "#/components/schemas/AfmObjectIdentifier" - }, - { - "$ref": "#/components/schemas/AfmLocalIdentifier" - } - ], - "type": "object" - }, - "AfmLocalIdentifier": { - "properties": { - "localIdentifier": { - "example": "sampleAutoGenerated0123_ID", - "pattern": "^[.a-zA-Z0-9_-]+$", - "type": "string" - } - }, - "required": [ - "localIdentifier" - ], - "type": "object" - }, - "AfmObjectIdentifier": { - "description": "ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.", - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "required" : [ "absoluteDateFilter" ], + "type" : "object" + }, + "AbstractMeasureValueFilter" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/ComparisonMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/RangeMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/CompoundMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/RankingFilter" + } ], + "type" : "object" + }, + "ActiveObjectIdentification" : { + "description" : "Object, with which the user is actively working.", + "properties" : { + "id" : { + "description" : "Object ID.", + "type" : "string" + }, + "type" : { + "description" : "Object type, e.g. dashboard.", + "type" : "string" + }, + "workspaceId" : { + "description" : "Workspace ID.", + "type" : "string" + } + }, + "required" : [ "id", "type", "workspaceId" ], + "type" : "object" + }, + "AfmCancelTokens" : { + "description" : "Any information related to cancellation.", + "properties" : { + "resultIdToCancelTokenPairs" : { + "additionalProperties" : { + "description" : "resultId to cancel token pairs", + "type" : "string" + }, + "description" : "resultId to cancel token pairs", + "type" : "object" + } + }, + "required" : [ "resultIdToCancelTokenPairs" ], + "type" : "object" + }, + "AfmExecution" : { + "properties" : { + "execution" : { + "$ref" : "#/components/schemas/AFM" + }, + "resultSpec" : { + "$ref" : "#/components/schemas/ResultSpec" + }, + "settings" : { + "$ref" : "#/components/schemas/ExecutionSettings" + } + }, + "required" : [ "execution", "resultSpec" ], + "type" : "object" + }, + "AfmExecutionResponse" : { + "description" : "Response to AFM execution request", + "properties" : { + "executionResponse" : { + "$ref" : "#/components/schemas/ExecutionResponse" + } + }, + "required" : [ "executionResponse" ], + "type" : "object" + }, + "AfmIdentifier" : { + "description" : "Reference to the attribute label to which the filter should be applied.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AfmObjectIdentifier" + }, { + "$ref" : "#/components/schemas/AfmLocalIdentifier" + } ], + "type" : "object" + }, + "AfmLocalIdentifier" : { + "properties" : { + "localIdentifier" : { + "example" : "sampleAutoGenerated0123_ID", + "pattern" : "^[.a-zA-Z0-9_-]+$", + "type" : "string" + } + }, + "required" : [ "localIdentifier" ], + "type" : "object" + }, + "AfmObjectIdentifier" : { + "description" : "ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.", + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "type": { - "enum": [ - "analyticalDashboard", - "attribute", - "dashboardPlugin", - "dataset", - "fact", - "label", - "metric", - "prompt", - "visualizationObject", - "filterContext" - ], - "example": "fact", - "type": "string" + "type" : { + "enum" : [ "analyticalDashboard", "attribute", "dashboardPlugin", "dataset", "fact", "label", "metric", "prompt", "visualizationObject", "filterContext" ], + "example" : "fact", + "type" : "string" } }, - "required": [ - "type", - "id" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AfmObjectIdentifierAttribute": { - "description": "Reference to the date attribute to use.", - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "required" : [ "type", "id" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AfmObjectIdentifierAttribute" : { + "description" : "Reference to the date attribute to use.", + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "type": { - "enum": [ - "attribute" - ], - "type": "string" + "type" : { + "enum" : [ "attribute" ], + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AfmObjectIdentifierCore": { - "description": "Reference to the metric, fact or attribute object to use for the metric.", - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "required" : [ "id", "type" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AfmObjectIdentifierCore" : { + "description" : "Reference to the metric, fact or attribute object to use for the metric.", + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "type": { - "enum": [ - "attribute", - "label", - "fact", - "metric" - ], - "type": "string" + "type" : { + "enum" : [ "attribute", "label", "fact", "metric" ], + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AfmObjectIdentifierDataset": { - "description": "Reference to the date dataset to which the filter should be applied.", - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "required" : [ "id", "type" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AfmObjectIdentifierDataset" : { + "description" : "Reference to the date dataset to which the filter should be applied.", + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "type": { - "enum": [ - "dataset" - ], - "type": "string" + "type" : { + "enum" : [ "dataset" ], + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AfmObjectIdentifierLabel": { - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "required" : [ "id", "type" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AfmObjectIdentifierLabel" : { + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "type": { - "enum": [ - "label" - ], - "type": "string" + "type" : { + "enum" : [ "label" ], + "type" : "string" } }, - "required": [ - "type", - "id" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AfmValidDescendantsQuery": { - "description": "Entity describing the valid descendants request.", - "properties": { - "attributes": { - "description": "List of identifiers of the attributes to get the valid descendants for.", - "items": { - "$ref": "#/components/schemas/AfmObjectIdentifierAttribute" - }, - "type": "array" - } - }, - "required": [ - "attributes" - ], - "type": "object" - }, - "AfmValidDescendantsResponse": { - "description": "Entity describing the valid descendants response.", - "properties": { - "validDescendants": { - "additionalProperties": { - "description": "Map of attribute identifiers to list of valid descendants identifiers.", - "items": { - "$ref": "#/components/schemas/AfmObjectIdentifierAttribute" + "required" : [ "type", "id" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AfmValidDescendantsQuery" : { + "description" : "Entity describing the valid descendants request.", + "properties" : { + "attributes" : { + "description" : "List of identifiers of the attributes to get the valid descendants for.", + "items" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierAttribute" + }, + "type" : "array" + } + }, + "required" : [ "attributes" ], + "type" : "object" + }, + "AfmValidDescendantsResponse" : { + "description" : "Entity describing the valid descendants response.", + "properties" : { + "validDescendants" : { + "additionalProperties" : { + "description" : "Map of attribute identifiers to list of valid descendants identifiers.", + "items" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierAttribute" }, - "type": "array" - }, - "description": "Map of attribute identifiers to list of valid descendants identifiers.", - "type": "object" - } - }, - "required": [ - "validDescendants" - ], - "type": "object" - }, - "AfmValidObjectsQuery": { - "description": "Entity holding AFM and list of object types whose validity should be computed.", - "properties": { - "afm": { - "$ref": "#/components/schemas/AFM" - }, - "types": { - "example": "facts", - "items": { - "enum": [ - "facts", - "attributes", - "measures" - ], - "example": "facts", - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "afm", - "types" - ], - "type": "object" - }, - "AfmValidObjectsResponse": { - "description": "All objects of specified types valid with respect to given AFM.", - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/RestApiIdentifier" - }, - "type": "array" - } - }, - "required": [ - "items" - ], - "type": "object" - }, - "AllowedRelationshipType": { - "description": "Allowed relationship type combination.", - "properties": { - "allowOrphans": { - "default": true, - "description": "If true, allows target objects that are not part of any relationship (orphans) to be included in results. If false, orphan target objects will be excluded even if they directly match the search query. Default is true (orphans are allowed).", - "type": "boolean" - }, - "sourceType": { - "description": "Source object type (e.g., 'dashboard', 'visualization', 'metric').", - "enum": [ - "attribute", - "metric", - "fact", - "label", - "date", - "dataset", - "visualization", - "dashboard" - ], - "type": "string" - }, - "targetType": { - "description": "Target object type (e.g., 'visualization', 'metric', 'attribute').", - "enum": [ - "attribute", - "metric", - "fact", - "label", - "date", - "dataset", - "visualization", - "dashboard" - ], - "type": "string" - } - }, - "required": [ - "sourceType", - "targetType" - ], - "type": "object" - }, - "AnalyticsCatalogCreatedBy": { - "properties": { - "reasoning": { - "description": "Reasoning for error states", - "type": "string" - }, - "users": { - "description": "Users who created any object in the catalog", - "items": { - "$ref": "#/components/schemas/AnalyticsCatalogUser" - }, - "type": "array" - } - }, - "required": [ - "reasoning", - "users" - ], - "type": "object" - }, - "AnalyticsCatalogTags": { - "properties": { - "tags": { - "items": { - "description": "Tags assigned to any object in the catalog", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "tags" - ], - "type": "object" - }, - "AnalyticsCatalogUser": { - "description": "Users who created any object in the catalog", - "properties": { - "firstname": { - "description": "First name of the user who created any objects", - "type": "string" - }, - "lastname": { - "description": "Last name of the user who created any objects", - "type": "string" - }, - "userId": { - "description": "User ID of the user who created any objects", - "type": "string" - } - }, - "required": [ - "firstname", - "lastname", - "userId" - ], - "type": "object" - }, - "AnomalyDetectionRequest": { - "properties": { - "sensitivity": { - "description": "Anomaly detection sensitivity.", - "format": "float", - "type": "number" - } - }, - "required": [ - "sensitivity" - ], - "type": "object" - }, - "AnomalyDetectionResult": { - "properties": { - "anomalyFlag": { - "items": { - "nullable": true, - "type": "boolean" - }, - "type": "array" - }, - "attribute": { - "items": { - "type": "string" - }, - "type": "array" - }, - "values": { - "items": { - "nullable": true, - "type": "number" - }, - "type": "array" - } - }, - "required": [ - "anomalyFlag", - "attribute", - "values" - ], - "type": "object" - }, - "ArithmeticMeasureDefinition": { - "description": "Metric representing arithmetics between other metrics.", - "properties": { - "arithmeticMeasure": { - "properties": { - "measureIdentifiers": { - "description": "List of metrics to apply arithmetic operation by chosen operator.", - "items": { - "$ref": "#/components/schemas/AfmLocalIdentifier" + "type" : "array" + }, + "description" : "Map of attribute identifiers to list of valid descendants identifiers.", + "type" : "object" + } + }, + "required" : [ "validDescendants" ], + "type" : "object" + }, + "AfmValidObjectsQuery" : { + "description" : "Entity holding AFM and list of object types whose validity should be computed.", + "properties" : { + "afm" : { + "$ref" : "#/components/schemas/AFM" + }, + "types" : { + "example" : "facts", + "items" : { + "enum" : [ "facts", "attributes", "measures" ], + "example" : "facts", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "afm", "types" ], + "type" : "object" + }, + "AfmValidObjectsResponse" : { + "description" : "All objects of specified types valid with respect to given AFM.", + "properties" : { + "items" : { + "items" : { + "$ref" : "#/components/schemas/RestApiIdentifier" + }, + "type" : "array" + } + }, + "required" : [ "items" ], + "type" : "object" + }, + "AllowedRelationshipType" : { + "description" : "Allowed relationship type combination.", + "properties" : { + "allowOrphans" : { + "default" : true, + "description" : "If true, allows target objects that are not part of any relationship (orphans) to be included in results. If false, orphan target objects will be excluded even if they directly match the search query. Default is true (orphans are allowed).", + "type" : "boolean" + }, + "sourceType" : { + "description" : "Source object type (e.g., 'dashboard', 'visualization', 'metric').", + "enum" : [ "attribute", "metric", "fact", "label", "date", "dataset", "visualization", "dashboard" ], + "type" : "string" + }, + "targetType" : { + "description" : "Target object type (e.g., 'visualization', 'metric', 'attribute').", + "enum" : [ "attribute", "metric", "fact", "label", "date", "dataset", "visualization", "dashboard" ], + "type" : "string" + } + }, + "required" : [ "sourceType", "targetType" ], + "type" : "object" + }, + "AnalyticsCatalogCreatedBy" : { + "properties" : { + "reasoning" : { + "description" : "Reasoning for error states", + "type" : "string" + }, + "users" : { + "description" : "Users who created any object in the catalog", + "items" : { + "$ref" : "#/components/schemas/AnalyticsCatalogUser" + }, + "type" : "array" + } + }, + "required" : [ "reasoning", "users" ], + "type" : "object" + }, + "AnalyticsCatalogTags" : { + "properties" : { + "tags" : { + "items" : { + "description" : "Tags assigned to any object in the catalog", + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ "tags" ], + "type" : "object" + }, + "AnalyticsCatalogUser" : { + "description" : "Users who created any object in the catalog", + "properties" : { + "firstname" : { + "description" : "First name of the user who created any objects", + "type" : "string" + }, + "lastname" : { + "description" : "Last name of the user who created any objects", + "type" : "string" + }, + "userId" : { + "description" : "User ID of the user who created any objects", + "type" : "string" + } + }, + "required" : [ "firstname", "lastname", "userId" ], + "type" : "object" + }, + "AnomalyDetectionRequest" : { + "properties" : { + "sensitivity" : { + "description" : "Anomaly detection sensitivity.", + "format" : "float", + "type" : "number" + } + }, + "required" : [ "sensitivity" ], + "type" : "object" + }, + "AnomalyDetectionResult" : { + "properties" : { + "anomalyFlag" : { + "items" : { + "nullable" : true, + "type" : "boolean" + }, + "type" : "array" + }, + "attribute" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "values" : { + "items" : { + "nullable" : true, + "type" : "number" + }, + "type" : "array" + } + }, + "required" : [ "anomalyFlag", "attribute", "values" ], + "type" : "object" + }, + "ArithmeticMeasureDefinition" : { + "description" : "Metric representing arithmetics between other metrics.", + "properties" : { + "arithmeticMeasure" : { + "properties" : { + "measureIdentifiers" : { + "description" : "List of metrics to apply arithmetic operation by chosen operator.", + "items" : { + "$ref" : "#/components/schemas/AfmLocalIdentifier" }, - "type": "array" + "type" : "array" }, - "operator": { - "description": "Arithmetic operator describing operation between metrics.", - "enum": [ - "SUM", - "DIFFERENCE", - "MULTIPLICATION", - "RATIO", - "CHANGE" - ], - "example": "SUM", - "type": "string" + "operator" : { + "description" : "Arithmetic operator describing operation between metrics.", + "enum" : [ "SUM", "DIFFERENCE", "MULTIPLICATION", "RATIO", "CHANGE" ], + "example" : "SUM", + "type" : "string" } }, - "required": [ - "measureIdentifiers", - "operator" - ], - "type": "object" - } - }, - "required": [ - "arithmeticMeasure" - ], - "type": "object" - }, - "AttributeExecutionResultHeader": { - "properties": { - "attributeHeader": { - "$ref": "#/components/schemas/AttributeResultHeader" - } - }, - "required": [ - "attributeHeader" - ], - "type": "object" - }, - "AttributeFilter": { - "description": "Abstract filter definition type attributes", - "oneOf": [ - { - "$ref": "#/components/schemas/NegativeAttributeFilter" - }, - { - "$ref": "#/components/schemas/PositiveAttributeFilter" - } - ], - "type": "object" - }, - "AttributeFilterElements": { - "description": "Filter on specific set of label values.", - "properties": { - "values": { - "description": "Set of label values.", - "example": [ - "value1", - "value2" - ], - "items": { - "nullable": true, - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "values" - ], - "type": "object" - }, - "AttributeFormat": { - "description": "Attribute format describes formatting information to effectively format attribute values when needed.", - "properties": { - "locale": { - "description": "Format locale code like 'en-US', 'cs-CZ', etc.", - "type": "string" - }, - "pattern": { - "description": "ICU formatting pattern like 'y', 'dd.MM.y', etc.", - "type": "string" - }, - "timezone": { - "description": "Timezone for date formatting like 'America/New_York', 'Europe/Prague', etc.", - "type": "string" - } - }, - "required": [ - "locale", - "pattern" - ], - "type": "object" - }, - "AttributeHeader": { - "properties": { - "attributeHeader": { - "properties": { - "attribute": { - "$ref": "#/components/schemas/RestApiIdentifier" + "required" : [ "measureIdentifiers", "operator" ], + "type" : "object" + } + }, + "required" : [ "arithmeticMeasure" ], + "type" : "object" + }, + "AttributeExecutionResultHeader" : { + "properties" : { + "attributeHeader" : { + "$ref" : "#/components/schemas/AttributeResultHeader" + } + }, + "required" : [ "attributeHeader" ], + "type" : "object" + }, + "AttributeFilter" : { + "description" : "Abstract filter definition type attributes", + "oneOf" : [ { + "$ref" : "#/components/schemas/NegativeAttributeFilter" + }, { + "$ref" : "#/components/schemas/PositiveAttributeFilter" + } ], + "type" : "object" + }, + "AttributeFilterElements" : { + "description" : "Filter on specific set of label values.", + "properties" : { + "values" : { + "description" : "Set of label values.", + "example" : [ "value1", "value2" ], + "items" : { + "nullable" : true, + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "values" ], + "type" : "object" + }, + "AttributeFormat" : { + "description" : "Attribute format describes formatting information to effectively format attribute values when needed.", + "properties" : { + "locale" : { + "description" : "Format locale code like 'en-US', 'cs-CZ', etc.", + "type" : "string" + }, + "pattern" : { + "description" : "ICU formatting pattern like 'y', 'dd.MM.y', etc.", + "type" : "string" + }, + "timezone" : { + "description" : "Timezone for date formatting like 'America/New_York', 'Europe/Prague', etc.", + "type" : "string" + } + }, + "required" : [ "locale", "pattern" ], + "type" : "object" + }, + "AttributeHeader" : { + "properties" : { + "attributeHeader" : { + "properties" : { + "attribute" : { + "$ref" : "#/components/schemas/RestApiIdentifier" }, - "attributeName": { - "description": "Attribute name.", - "type": "string" + "attributeName" : { + "description" : "Attribute name.", + "type" : "string" }, - "format": { - "$ref": "#/components/schemas/AttributeFormat" + "format" : { + "$ref" : "#/components/schemas/AttributeFormat" }, - "geoAreaConfig": { - "$ref": "#/components/schemas/GeoAreaConfig" + "geoAreaConfig" : { + "$ref" : "#/components/schemas/GeoAreaConfig" }, - "granularity": { - "description": "Date granularity of the attribute, only filled for date attributes.", - "enum": [ - "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", - "MINUTE_OF_HOUR", - "HOUR_OF_DAY", - "DAY_OF_WEEK", - "DAY_OF_MONTH", - "DAY_OF_QUARTER", - "DAY_OF_YEAR", - "WEEK_OF_YEAR", - "MONTH_OF_YEAR", - "QUARTER_OF_YEAR", - "FISCAL_MONTH", - "FISCAL_QUARTER", - "FISCAL_YEAR" - ], - "type": "string" + "granularity" : { + "description" : "Date granularity of the attribute, only filled for date attributes.", + "enum" : [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], + "type" : "string" }, - "label": { - "$ref": "#/components/schemas/RestApiIdentifier" + "label" : { + "$ref" : "#/components/schemas/RestApiIdentifier" }, - "labelName": { - "description": "Label name.", - "type": "string" + "labelName" : { + "description" : "Label name.", + "type" : "string" }, - "localIdentifier": { - "description": "Local identifier of the attribute this header relates to.", - "pattern": "^[.a-zA-Z0-9_-]+$", - "type": "string" + "localIdentifier" : { + "description" : "Local identifier of the attribute this header relates to.", + "pattern" : "^[.a-zA-Z0-9_-]+$", + "type" : "string" }, - "primaryLabel": { - "$ref": "#/components/schemas/RestApiIdentifier" + "primaryLabel" : { + "$ref" : "#/components/schemas/RestApiIdentifier" }, - "valueType": { - "description": "Attribute value type.", - "enum": [ - "TEXT", - "HYPERLINK", - "GEO", - "GEO_LONGITUDE", - "GEO_LATITUDE", - "GEO_AREA", - "IMAGE" - ], - "type": "string" + "valueType" : { + "description" : "Attribute value type.", + "enum" : [ "TEXT", "HYPERLINK", "GEO", "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", "IMAGE" ], + "type" : "string" } }, - "required": [ - "attribute", - "attributeName", - "label", - "labelName", - "localIdentifier", - "primaryLabel" - ], - "type": "object" - } - }, - "required": [ - "attributeHeader" - ], - "type": "object" - }, - "AttributeItem": { - "properties": { - "label": { - "$ref": "#/components/schemas/AfmObjectIdentifierLabel" - }, - "localIdentifier": { - "description": "Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.", - "example": "attribute_1", - "pattern": "^[.a-zA-Z0-9_-]+$", - "type": "string" - }, - "showAllValues": { - "default": false, - "description": "Indicates whether to show all values of given attribute even if the data bound to those values is not available.", - "type": "boolean" - } - }, - "required": [ - "label", - "localIdentifier" - ], - "type": "object" - }, - "AttributeNegativeFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/Filter" - }, - { - "properties": { - "exclude": { - "items": { - "type": "string" - }, - "type": "array" + "required" : [ "attribute", "attributeName", "label", "labelName", "localIdentifier", "primaryLabel" ], + "type" : "object" + } + }, + "required" : [ "attributeHeader" ], + "type" : "object" + }, + "AttributeItem" : { + "properties" : { + "label" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierLabel" + }, + "localIdentifier" : { + "description" : "Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.", + "example" : "attribute_1", + "pattern" : "^[.a-zA-Z0-9_-]+$", + "type" : "string" + }, + "showAllValues" : { + "default" : false, + "description" : "Indicates whether to show all values of given attribute even if the data bound to those values is not available.", + "type" : "boolean" + } + }, + "required" : [ "label", "localIdentifier" ], + "type" : "object" + }, + "AttributeNegativeFilter" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Filter" + }, { + "properties" : { + "exclude" : { + "items" : { + "type" : "string" }, - "using": { - "type": "string" - } + "type" : "array" }, - "type": "object" - } - ], - "required": [ - "exclude", - "using" - ], - "type": "object" - }, - "AttributePositiveFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/Filter" - }, - { - "properties": { - "include": { - "items": { - "type": "string" - }, - "type": "array" + "using" : { + "type" : "string" + } + }, + "type" : "object" + } ], + "required" : [ "exclude", "using" ], + "type" : "object" + }, + "AttributePositiveFilter" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Filter" + }, { + "properties" : { + "include" : { + "items" : { + "type" : "string" }, - "using": { - "type": "string" - } + "type" : "array" }, - "type": "object" - } - ], - "required": [ - "include", - "using" - ], - "type": "object" - }, - "AttributeResultHeader": { - "description": "Header containing the information related to attributes.", - "properties": { - "labelValue": { - "description": "A value of the current attribute label.", - "example": "East Coast", - "type": "string" - }, - "primaryLabelValue": { - "description": "A value of the primary attribute label.", - "example": "1225", - "type": "string" - } - }, - "required": [ - "labelValue", - "primaryLabelValue" - ], - "type": "object" - }, - "BoundedFilter": { - "description": "Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range.", - "properties": { - "from": { - "description": "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). If null, then start of the range is unbounded.", - "example": -6, - "format": "int32", - "nullable": true, - "type": "integer" - }, - "granularity": { - "description": "Date granularity specifying particular date attribute in given dimension.", - "enum": [ - "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", - "MINUTE_OF_HOUR", - "HOUR_OF_DAY", - "DAY_OF_WEEK", - "DAY_OF_MONTH", - "DAY_OF_QUARTER", - "DAY_OF_YEAR", - "WEEK_OF_YEAR", - "MONTH_OF_YEAR", - "QUARTER_OF_YEAR", - "FISCAL_MONTH", - "FISCAL_QUARTER", - "FISCAL_YEAR" - ], - "example": "DAY", - "type": "string" - }, - "to": { - "description": "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.", - "example": 0, - "format": "int32", - "nullable": true, - "type": "integer" - } - }, - "required": [ - "granularity" - ], - "type": "object" - }, - "ChangeAnalysisParams": { - "description": "Change analysis specification.", - "properties": { - "analyzedPeriod": { - "description": "The analyzed time period", - "type": "string" - }, - "attributes": { - "description": "Attributes to analyze for significant changes", - "items": { - "$ref": "#/components/schemas/AttributeItem" - }, - "type": "array" - }, - "dateAttribute": { - "$ref": "#/components/schemas/AttributeItem" - }, - "filters": { - "description": "Optional filters to apply", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AbstractMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" - }, - { - "$ref": "#/components/schemas/InlineFilterDefinition" - } - ] - }, - "type": "array" - }, - "measure": { - "$ref": "#/components/schemas/MeasureItem" - }, - "measureTitle": { - "description": "The title of the measure being analyzed", - "type": "string" - }, - "referencePeriod": { - "description": "The reference time period", - "type": "string" - }, - "useSmartAttributeSelection": { - "description": "Whether to use smart attribute selection", - "type": "boolean" - } - }, - "required": [ - "analyzedPeriod", - "attributes", - "dateAttribute", - "filters", - "measure", - "measureTitle", - "referencePeriod", - "useSmartAttributeSelection" - ], - "type": "object" - }, - "ChangeAnalysisRequest": { - "description": "Request for change analysis computation", - "properties": { - "analyzedPeriod": { - "description": "The analyzed time period (e.g., '2025-02')", - "type": "string" - }, - "attributes": { - "description": "Attributes to analyze for significant changes. If empty, valid attributes will be automatically discovered.", - "items": { - "$ref": "#/components/schemas/AttributeItem" - }, - "type": "array" - }, - "auxMeasures": { - "description": "Auxiliary measures", - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "type": "array" - }, - "dateAttribute": { - "$ref": "#/components/schemas/AttributeItem" - }, - "excludeTags": { - "description": "Exclude attributes with any of these tags. This filter applies to both auto-discovered and explicitly provided attributes.", - "items": { - "description": "Exclude attributes with any of these tags. This filter applies to both auto-discovered and explicitly provided attributes.", - "type": "string" - }, - "type": "array" - }, - "filters": { - "description": "Optional filters to apply.", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AbstractMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" - }, - { - "$ref": "#/components/schemas/InlineFilterDefinition" - } - ] + "using" : { + "type" : "string" + } + }, + "type" : "object" + } ], + "required" : [ "include", "using" ], + "type" : "object" + }, + "AttributeResultHeader" : { + "description" : "Header containing the information related to attributes.", + "properties" : { + "labelValue" : { + "description" : "A value of the current attribute label.", + "example" : "East Coast", + "type" : "string" + }, + "primaryLabelValue" : { + "description" : "A value of the primary attribute label.", + "example" : "1225", + "type" : "string" + } + }, + "required" : [ "labelValue", "primaryLabelValue" ], + "type" : "object" + }, + "BoundedFilter" : { + "description" : "Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range.", + "properties" : { + "from" : { + "description" : "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). If null, then start of the range is unbounded.", + "example" : -6, + "format" : "int32", + "nullable" : true, + "type" : "integer" + }, + "granularity" : { + "description" : "Date granularity specifying particular date attribute in given dimension.", + "enum" : [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], + "example" : "DAY", + "type" : "string" + }, + "to" : { + "description" : "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.", + "example" : 0, + "format" : "int32", + "nullable" : true, + "type" : "integer" + } + }, + "required" : [ "granularity" ], + "type" : "object" + }, + "ChangeAnalysisParams" : { + "description" : "Change analysis specification.", + "properties" : { + "analyzedPeriod" : { + "description" : "The analyzed time period", + "type" : "string" + }, + "attributes" : { + "description" : "Attributes to analyze for significant changes", + "items" : { + "$ref" : "#/components/schemas/AttributeItem" + }, + "type" : "array" + }, + "dateAttribute" : { + "$ref" : "#/components/schemas/AttributeItem" + }, + "filters" : { + "description" : "Optional filters to apply", + "items" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/AbstractMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/FilterDefinitionForSimpleMeasure" + }, { + "$ref" : "#/components/schemas/InlineFilterDefinition" + } ] + }, + "type" : "array" + }, + "measure" : { + "$ref" : "#/components/schemas/MeasureItem" + }, + "measureTitle" : { + "description" : "The title of the measure being analyzed", + "type" : "string" + }, + "referencePeriod" : { + "description" : "The reference time period", + "type" : "string" + }, + "useSmartAttributeSelection" : { + "description" : "Whether to use smart attribute selection", + "type" : "boolean" + } + }, + "required" : [ "analyzedPeriod", "attributes", "dateAttribute", "filters", "measure", "measureTitle", "referencePeriod", "useSmartAttributeSelection" ], + "type" : "object" + }, + "ChangeAnalysisRequest" : { + "description" : "Request for change analysis computation", + "properties" : { + "analyzedPeriod" : { + "description" : "The analyzed time period (e.g., '2025-02')", + "type" : "string" + }, + "attributes" : { + "description" : "Attributes to analyze for significant changes. If empty, valid attributes will be automatically discovered.", + "items" : { + "$ref" : "#/components/schemas/AttributeItem" + }, + "type" : "array" + }, + "auxMeasures" : { + "description" : "Auxiliary measures", + "items" : { + "$ref" : "#/components/schemas/MeasureItem" + }, + "type" : "array" + }, + "dateAttribute" : { + "$ref" : "#/components/schemas/AttributeItem" + }, + "excludeTags" : { + "description" : "Exclude attributes with any of these tags. This filter applies to both auto-discovered and explicitly provided attributes.", + "items" : { + "description" : "Exclude attributes with any of these tags. This filter applies to both auto-discovered and explicitly provided attributes.", + "type" : "string" }, - "type": "array" + "type" : "array" }, - "includeTags": { - "description": "Only include attributes with at least one of these tags. If empty, no inclusion filter is applied. This filter applies to both auto-discovered and explicitly provided attributes.", - "items": { - "description": "Only include attributes with at least one of these tags. If empty, no inclusion filter is applied. This filter applies to both auto-discovered and explicitly provided attributes.", - "type": "string" + "filters" : { + "description" : "Optional filters to apply.", + "items" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/AbstractMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/FilterDefinitionForSimpleMeasure" + }, { + "$ref" : "#/components/schemas/InlineFilterDefinition" + } ] }, - "type": "array" + "type" : "array" }, - "measure": { - "$ref": "#/components/schemas/MeasureItem" + "includeTags" : { + "description" : "Only include attributes with at least one of these tags. If empty, no inclusion filter is applied. This filter applies to both auto-discovered and explicitly provided attributes.", + "items" : { + "description" : "Only include attributes with at least one of these tags. If empty, no inclusion filter is applied. This filter applies to both auto-discovered and explicitly provided attributes.", + "type" : "string" + }, + "type" : "array" + }, + "measure" : { + "$ref" : "#/components/schemas/MeasureItem" }, - "referencePeriod": { - "description": "The reference time period (e.g., '2025-01')", - "type": "string" + "referencePeriod" : { + "description" : "The reference time period (e.g., '2025-01')", + "type" : "string" }, - "useSmartAttributeSelection": { - "default": false, - "description": "Whether to use smart attribute selection (LLM-based) instead of discovering all valid attributes. If true, GenAI will intelligently select the most relevant attributes for change analysis. If false or not set, all valid attributes will be discovered using Calcique. Smart attribute selection applies only when no attributes are provided.", - "type": "boolean" - } + "useSmartAttributeSelection" : { + "default" : false, + "description" : "Whether to use smart attribute selection (LLM-based) instead of discovering all valid attributes. If true, GenAI will intelligently select the most relevant attributes for change analysis. If false or not set, all valid attributes will be discovered using Calcique. Smart attribute selection applies only when no attributes are provided.", + "type" : "boolean" + } + }, + "required" : [ "analyzedPeriod", "dateAttribute", "measure", "referencePeriod" ], + "type" : "object" + }, + "ChangeAnalysisResponse" : { + "description" : "Response for change analysis computation", + "properties" : { + "links" : { + "$ref" : "#/components/schemas/ExecutionLinks" + } }, - "required": [ - "analyzedPeriod", - "dateAttribute", - "measure", - "referencePeriod" - ], - "type": "object" - }, - "ChangeAnalysisResponse": { - "description": "Response for change analysis computation", - "properties": { - "links": { - "$ref": "#/components/schemas/ExecutionLinks" - } - }, - "required": [ - "links" - ], - "type": "object" - }, - "ChangeAnalysisResult": { - "description": "Result of a change analysis execution.", - "properties": { - "data": { - "description": "The change analysis result data containing significant changes.", - "items": { - "$ref": "#/components/schemas/MetricValueChange" - }, - "type": "array" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "ChatHistoryInteraction": { - "description": "List of chat history interactions.", - "properties": { - "changeAnalysisParams": { - "$ref": "#/components/schemas/ChangeAnalysisParams" - }, - "chatHistoryInteractionId": { - "description": "Chat History interaction ID. Unique ID for each interaction.", - "type": "string" - }, - "createdVisualizations": { - "$ref": "#/components/schemas/CreatedVisualizations" - }, - "errorResponse": { - "description": "Error response in anything fails.", - "type": "string" - }, - "foundObjects": { - "$ref": "#/components/schemas/FoundObjects" - }, - "interactionFinished": { - "description": "Has the interaction already finished? Can be used for polling when interaction is in progress.", - "type": "boolean" - }, - "question": { - "description": "User question", - "maxLength": 2000, - "type": "string" - }, - "reasoning": { - "$ref": "#/components/schemas/Reasoning" - }, - "routing": { - "$ref": "#/components/schemas/RouteResult" - }, - "semanticSearch": { - "$ref": "#/components/schemas/SearchResult" - }, - "textResponse": { - "description": "Text response for general questions.", - "type": "string" - }, - "threadIdSuffix": { - "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", - "type": "string" - }, - "userFeedback": { - "description": "User feedback.", - "enum": [ - "POSITIVE", - "NEGATIVE", - "NONE" - ], - "type": "string" - } - }, - "required": [ - "chatHistoryInteractionId", - "interactionFinished", - "question", - "routing" - ], - "type": "object" - }, - "ChatHistoryRequest": { - "properties": { - "chatHistoryInteractionId": { - "description": "Return chat history records only after this interaction ID. If empty, complete chat history is returned.", - "type": "string" - }, - "reset": { - "description": "User feedback.", - "type": "boolean" - }, - "responseState": { - "description": "Response state indicating the outcome of the AI interaction.", - "enum": [ - "SUCCESSFUL", - "UNEXPECTED_ERROR", - "NOT_FOUND_ATTRIBUTES", - "TOO_MANY_DATA_POINTS", - "NO_DATA", - "NO_RESULTS", - "OUT_OF_TOPIC" - ], - "type": "string" - }, - "savedVisualization": { - "$ref": "#/components/schemas/SavedVisualization" - }, - "threadIdSuffix": { - "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", - "type": "string" - }, - "userFeedback": { - "description": "User feedback.", - "enum": [ - "POSITIVE", - "NEGATIVE", - "NONE" - ], - "type": "string" - }, - "userTextFeedback": { - "description": "User text feedback for the interaction.", - "type": "string" - } - }, - "type": "object" - }, - "ChatHistoryResult": { - "properties": { - "interactions": { - "description": "List of chat history interactions.", - "items": { - "$ref": "#/components/schemas/ChatHistoryInteraction" - }, - "type": "array" - }, - "threadId": { - "description": "The conversation thread ID.", - "type": "string" - } - }, - "required": [ - "interactions", - "threadId" - ], - "type": "object" - }, - "ChatRequest": { - "properties": { - "allowedRelationshipTypes": { - "description": "Filter relationships and search results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned (e.g. for view-only users).", - "items": { - "$ref": "#/components/schemas/AllowedRelationshipType" - }, - "type": "array" - }, - "includeHidden": { - "default": false, - "description": "If true, includes hidden objects in search and visualization building. If false (default), excludes objects where isHidden=true.", - "type": "boolean" - }, - "limitCreate": { - "default": 3, - "description": "Maximum number of created results.", - "format": "int32", - "type": "integer" - }, - "limitCreateContext": { - "default": 10, - "description": "Maximum number of relevant objects included into context for LLM (for each object type).", - "format": "int32", - "type": "integer" - }, - "limitSearch": { - "default": 5, - "description": "Maximum number of search results.", - "format": "int32", - "type": "integer" - }, - "objectTypes": { - "description": "List of object types to filter the search and visualization building. If empty or null, all object types are considered.", - "items": { - "description": "Object type to filter.", - "enum": [ - "attribute", - "metric", - "fact", - "label", - "date", - "dataset", - "visualization", - "dashboard" - ], - "type": "string" - }, - "type": "array" - }, - "question": { - "description": "User question", - "maxLength": 2000, - "type": "string" - }, - "relevantScoreThreshold": { - "default": 0.45, - "description": "Score, above which we return found objects. Below this score objects are not relevant.", - "format": "double", - "type": "number" - }, - "searchScoreThreshold": { - "default": 0.9, - "description": "Score, above which we return found object(s) and don't call LLM to create new objects.", - "format": "double", - "type": "number" - }, - "threadIdSuffix": { - "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", - "type": "string" - }, - "titleToDescriptorRatio": { - "default": 0.7, - "description": "Temporary for experiments. Ratio of title score to descriptor score.", - "format": "double", - "type": "number" - }, - "userContext": { - "$ref": "#/components/schemas/UserContext" - } - }, - "required": [ - "question" - ], - "type": "object" - }, - "ChatResult": { - "properties": { - "changeAnalysisParams": { - "$ref": "#/components/schemas/ChangeAnalysisParams" - }, - "chatHistoryInteractionId": { - "description": "Chat History interaction ID. Unique ID for each interaction.", - "type": "string" - }, - "createdVisualizations": { - "$ref": "#/components/schemas/CreatedVisualizations" - }, - "errorResponse": { - "description": "Error response in anything fails.", - "type": "string" - }, - "foundObjects": { - "$ref": "#/components/schemas/FoundObjects" - }, - "reasoning": { - "$ref": "#/components/schemas/Reasoning" - }, - "routing": { - "$ref": "#/components/schemas/RouteResult" - }, - "semanticSearch": { - "$ref": "#/components/schemas/SearchResult" - }, - "textResponse": { - "description": "Text response for general questions.", - "type": "string" - }, - "threadIdSuffix": { - "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", - "type": "string" - } - }, - "type": "object" - }, - "ChatUsageResponse": { - "properties": { - "interactionCount": { - "description": "Number of interactions in the time window", - "format": "int32", - "type": "integer" - }, - "interactionLimit": { - "description": "Maximum number of interactions in the time window any user can do in the workspace", - "format": "int32", - "type": "integer" - }, - "timeWindowHours": { - "description": "Time window in hours", - "format": "int32", - "type": "integer" - } - }, - "required": [ - "interactionCount", - "interactionLimit", - "timeWindowHours" - ], - "type": "object" - }, - "ClusteringRequest": { - "properties": { - "numberOfClusters": { - "description": "Number of clusters to create", - "format": "int32", - "minimum": 1, - "type": "integer" - }, - "threshold": { - "default": 0.03, - "description": "Threshold used for algorithm", - "exclusiveMinimum": true, - "format": "double", - "minimum": 0, - "type": "number" - } - }, - "required": [ - "numberOfClusters" - ], - "type": "object" - }, - "ClusteringResult": { - "properties": { - "attribute": { - "items": { - "type": "object" - }, - "type": "array" - }, - "clusters": { - "items": { - "format": "int32", - "nullable": true, - "type": "integer" - }, - "type": "array" - }, - "xCoord": { - "items": { - "nullable": true, - "type": "number" - }, - "type": "array", - "writeOnly": true - }, - "xcoord": { - "items": { - "type": "number" - }, - "type": "array" - }, - "yCoord": { - "items": { - "nullable": true, - "type": "number" - }, - "type": "array", - "writeOnly": true - }, - "ycoord": { - "items": { - "type": "number" - }, - "type": "array" - } - }, - "required": [ - "attribute", - "clusters", - "xcoord", - "ycoord" - ], - "type": "object" - }, - "ComparisonCondition": { - "description": "Condition that compares the metric value to a given constant value using a comparison operator.", - "properties": { - "comparison": { - "properties": { - "operator": { - "enum": [ - "GREATER_THAN", - "GREATER_THAN_OR_EQUAL_TO", - "LESS_THAN", - "LESS_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO" - ], - "example": "GREATER_THAN", - "type": "string" + "required" : [ "links" ], + "type" : "object" + }, + "ChangeAnalysisResult" : { + "description" : "Result of a change analysis execution.", + "properties" : { + "data" : { + "description" : "The change analysis result data containing significant changes.", + "items" : { + "$ref" : "#/components/schemas/MetricValueChange" + }, + "type" : "array" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "ChatHistoryInteraction" : { + "description" : "List of chat history interactions.", + "properties" : { + "changeAnalysisParams" : { + "$ref" : "#/components/schemas/ChangeAnalysisParams" + }, + "chatHistoryInteractionId" : { + "description" : "Chat History interaction ID. Unique ID for each interaction.", + "type" : "string" + }, + "createdVisualizations" : { + "$ref" : "#/components/schemas/CreatedVisualizations" + }, + "errorResponse" : { + "description" : "Error response in anything fails.", + "type" : "string" + }, + "foundObjects" : { + "$ref" : "#/components/schemas/FoundObjects" + }, + "interactionFinished" : { + "description" : "Has the interaction already finished? Can be used for polling when interaction is in progress.", + "type" : "boolean" + }, + "question" : { + "description" : "User question", + "maxLength" : 2000, + "type" : "string" + }, + "reasoning" : { + "$ref" : "#/components/schemas/Reasoning" + }, + "routing" : { + "$ref" : "#/components/schemas/RouteResult" + }, + "semanticSearch" : { + "$ref" : "#/components/schemas/SearchResult" + }, + "textResponse" : { + "description" : "Text response for general questions.", + "type" : "string" + }, + "threadIdSuffix" : { + "description" : "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", + "type" : "string" + }, + "userFeedback" : { + "description" : "User feedback.", + "enum" : [ "POSITIVE", "NEGATIVE", "NONE" ], + "type" : "string" + } + }, + "required" : [ "chatHistoryInteractionId", "interactionFinished", "question", "routing" ], + "type" : "object" + }, + "ChatHistoryRequest" : { + "properties" : { + "chatHistoryInteractionId" : { + "description" : "Return chat history records only after this interaction ID. If empty, complete chat history is returned.", + "type" : "string" + }, + "reset" : { + "description" : "User feedback.", + "type" : "boolean" + }, + "responseState" : { + "description" : "Response state indicating the outcome of the AI interaction.", + "enum" : [ "SUCCESSFUL", "UNEXPECTED_ERROR", "NOT_FOUND_ATTRIBUTES", "TOO_MANY_DATA_POINTS", "NO_DATA", "NO_RESULTS", "OUT_OF_TOPIC" ], + "type" : "string" + }, + "savedVisualization" : { + "$ref" : "#/components/schemas/SavedVisualization" + }, + "threadIdSuffix" : { + "description" : "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", + "type" : "string" + }, + "userFeedback" : { + "description" : "User feedback.", + "enum" : [ "POSITIVE", "NEGATIVE", "NONE" ], + "type" : "string" + }, + "userTextFeedback" : { + "description" : "User text feedback for the interaction.", + "type" : "string" + } + }, + "type" : "object" + }, + "ChatHistoryResult" : { + "properties" : { + "interactions" : { + "description" : "List of chat history interactions.", + "items" : { + "$ref" : "#/components/schemas/ChatHistoryInteraction" + }, + "type" : "array" + }, + "threadId" : { + "description" : "The conversation thread ID.", + "type" : "string" + } + }, + "required" : [ "interactions", "threadId" ], + "type" : "object" + }, + "ChatRequest" : { + "properties" : { + "allowedRelationshipTypes" : { + "description" : "Filter relationships and search results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned (e.g. for view-only users).", + "items" : { + "$ref" : "#/components/schemas/AllowedRelationshipType" + }, + "type" : "array" + }, + "includeHidden" : { + "default" : false, + "description" : "If true, includes hidden objects in search and visualization building. If false (default), excludes objects where isHidden=true.", + "type" : "boolean" + }, + "limitCreate" : { + "default" : 3, + "description" : "Maximum number of created results.", + "format" : "int32", + "type" : "integer" + }, + "limitCreateContext" : { + "default" : 10, + "description" : "Maximum number of relevant objects included into context for LLM (for each object type).", + "format" : "int32", + "type" : "integer" + }, + "limitSearch" : { + "default" : 5, + "description" : "Maximum number of search results.", + "format" : "int32", + "type" : "integer" + }, + "objectTypes" : { + "description" : "List of object types to filter the search and visualization building. If empty or null, all object types are considered.", + "items" : { + "description" : "Object type to filter.", + "enum" : [ "attribute", "metric", "fact", "label", "date", "dataset", "visualization", "dashboard" ], + "type" : "string" + }, + "type" : "array" + }, + "question" : { + "description" : "User question", + "maxLength" : 2000, + "type" : "string" + }, + "relevantScoreThreshold" : { + "default" : 0.45, + "description" : "Score, above which we return found objects. Below this score objects are not relevant.", + "format" : "double", + "type" : "number" + }, + "searchScoreThreshold" : { + "default" : 0.9, + "description" : "Score, above which we return found object(s) and don't call LLM to create new objects.", + "format" : "double", + "type" : "number" + }, + "threadIdSuffix" : { + "description" : "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", + "type" : "string" + }, + "titleToDescriptorRatio" : { + "default" : 0.7, + "description" : "Temporary for experiments. Ratio of title score to descriptor score.", + "format" : "double", + "type" : "number" + }, + "userContext" : { + "$ref" : "#/components/schemas/UserContext" + } + }, + "required" : [ "question" ], + "type" : "object" + }, + "ChatResult" : { + "properties" : { + "changeAnalysisParams" : { + "$ref" : "#/components/schemas/ChangeAnalysisParams" + }, + "chatHistoryInteractionId" : { + "description" : "Chat History interaction ID. Unique ID for each interaction.", + "type" : "string" + }, + "createdVisualizations" : { + "$ref" : "#/components/schemas/CreatedVisualizations" + }, + "errorResponse" : { + "description" : "Error response in anything fails.", + "type" : "string" + }, + "foundObjects" : { + "$ref" : "#/components/schemas/FoundObjects" + }, + "reasoning" : { + "$ref" : "#/components/schemas/Reasoning" + }, + "routing" : { + "$ref" : "#/components/schemas/RouteResult" + }, + "semanticSearch" : { + "$ref" : "#/components/schemas/SearchResult" + }, + "textResponse" : { + "description" : "Text response for general questions.", + "type" : "string" + }, + "threadIdSuffix" : { + "description" : "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", + "type" : "string" + } + }, + "type" : "object" + }, + "ChatUsageResponse" : { + "properties" : { + "interactionCount" : { + "description" : "Number of interactions in the time window", + "format" : "int32", + "type" : "integer" + }, + "interactionLimit" : { + "description" : "Maximum number of interactions in the time window any user can do in the workspace", + "format" : "int32", + "type" : "integer" + }, + "timeWindowHours" : { + "description" : "Time window in hours", + "format" : "int32", + "type" : "integer" + } + }, + "required" : [ "interactionCount", "interactionLimit", "timeWindowHours" ], + "type" : "object" + }, + "ClusteringRequest" : { + "properties" : { + "numberOfClusters" : { + "description" : "Number of clusters to create", + "format" : "int32", + "minimum" : 1, + "type" : "integer" + }, + "threshold" : { + "default" : 0.03, + "description" : "Threshold used for algorithm", + "exclusiveMinimum" : true, + "format" : "double", + "minimum" : 0, + "type" : "number" + } + }, + "required" : [ "numberOfClusters" ], + "type" : "object" + }, + "ClusteringResult" : { + "properties" : { + "attribute" : { + "items" : { + "type" : "object" + }, + "type" : "array" + }, + "clusters" : { + "items" : { + "format" : "int32", + "nullable" : true, + "type" : "integer" + }, + "type" : "array" + }, + "xCoord" : { + "items" : { + "nullable" : true, + "type" : "number" + }, + "type" : "array", + "writeOnly" : true + }, + "xcoord" : { + "items" : { + "type" : "number" + }, + "type" : "array" + }, + "yCoord" : { + "items" : { + "nullable" : true, + "type" : "number" + }, + "type" : "array", + "writeOnly" : true + }, + "ycoord" : { + "items" : { + "type" : "number" + }, + "type" : "array" + } + }, + "required" : [ "attribute", "clusters", "xcoord", "ycoord" ], + "type" : "object" + }, + "ComparisonCondition" : { + "description" : "Condition that compares the metric value to a given constant value using a comparison operator.", + "properties" : { + "comparison" : { + "properties" : { + "operator" : { + "enum" : [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ], + "example" : "GREATER_THAN", + "type" : "string" }, - "value": { - "example": 100, - "type": "number" + "value" : { + "example" : 100, + "type" : "number" } }, - "required": [ - "operator", - "value" - ], - "type": "object" - } - }, - "required": [ - "comparison" - ], - "type": "object" - }, - "ComparisonMeasureValueFilter": { - "description": "Filter the result by comparing specified metric to given constant value, using given comparison operator.", - "properties": { - "comparisonMeasureValueFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" + "required" : [ "operator", "value" ], + "type" : "object" + } + }, + "required" : [ "comparison" ], + "type" : "object" + }, + "ComparisonMeasureValueFilter" : { + "description" : "Filter the result by comparing specified metric to given constant value, using given comparison operator.", + "properties" : { + "comparisonMeasureValueFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" + "dimensionality" : { + "description" : "References to the attributes to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "type": "array" + "type" : "array" }, - "localIdentifier": { - "type": "string" + "localIdentifier" : { + "type" : "string" }, - "measure": { - "$ref": "#/components/schemas/AfmIdentifier" + "measure" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "operator": { - "enum": [ - "GREATER_THAN", - "GREATER_THAN_OR_EQUAL_TO", - "LESS_THAN", - "LESS_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO" - ], - "example": "GREATER_THAN", - "type": "string" + "operator" : { + "enum" : [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ], + "example" : "GREATER_THAN", + "type" : "string" }, - "treatNullValuesAs": { - "description": "A value that will be substituted for null values in the metric for the comparisons.", - "example": 0, - "type": "number" + "treatNullValuesAs" : { + "description" : "A value that will be substituted for null values in the metric for the comparisons.", + "example" : 0, + "type" : "number" }, - "value": { - "example": 1327, - "type": "number" + "value" : { + "example" : 1327, + "type" : "number" } }, - "required": [ - "operator", - "value", - "measure" - ], - "type": "object" - } - }, - "required": [ - "comparisonMeasureValueFilter" - ], - "type": "object" - }, - "CompoundMeasureValueFilter": { - "description": "Filter the result by applying multiple comparison and/or range conditions combined with OR logic. If conditions list is empty, no filtering is applied (all rows are returned).", - "properties": { - "compoundMeasureValueFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" + "required" : [ "operator", "value", "measure" ], + "type" : "object" + } + }, + "required" : [ "comparisonMeasureValueFilter" ], + "type" : "object" + }, + "CompoundMeasureValueFilter" : { + "description" : "Filter the result by applying multiple comparison and/or range conditions combined with OR logic. If conditions list is empty, no filtering is applied (all rows are returned).", + "properties" : { + "compoundMeasureValueFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" }, - "conditions": { - "description": "List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned.", - "items": { - "$ref": "#/components/schemas/MeasureValueCondition" + "conditions" : { + "description" : "List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned.", + "items" : { + "$ref" : "#/components/schemas/MeasureValueCondition" }, - "type": "array" + "type" : "array" }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" + "dimensionality" : { + "description" : "References to the attributes to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "type": "array" + "type" : "array" }, - "localIdentifier": { - "type": "string" + "localIdentifier" : { + "type" : "string" }, - "measure": { - "$ref": "#/components/schemas/AfmIdentifier" + "measure" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "treatNullValuesAs": { - "description": "A value that will be substituted for null values in the metric for the comparisons.", - "example": 0, - "type": "number" + "treatNullValuesAs" : { + "description" : "A value that will be substituted for null values in the metric for the comparisons.", + "example" : 0, + "type" : "number" } }, - "required": [ - "conditions", - "measure" - ], - "type": "object" - } - }, - "required": [ - "compoundMeasureValueFilter" - ], - "type": "object" - }, - "CreatedVisualization": { - "description": "List of created visualization objects", - "properties": { - "dimensionality": { - "description": "List of attributes representing the dimensionality of the new visualization", - "items": { - "$ref": "#/components/schemas/DimAttribute" - }, - "type": "array" - }, - "filters": { - "description": "List of filters to be applied to the new visualization", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AttributeNegativeFilter" - }, - { - "$ref": "#/components/schemas/AttributePositiveFilter" - }, - { - "$ref": "#/components/schemas/DateAbsoluteFilter" - }, - { - "$ref": "#/components/schemas/DateRelativeFilter" - }, - { - "$ref": "#/components/schemas/RankingFilter" - } - ] - }, - "type": "array" - }, - "id": { - "description": "Proposed ID of the new visualization", - "example": "revenue_by_country", - "type": "string" - }, - "metrics": { - "description": "List of metrics to be used in the new visualization", - "items": { - "$ref": "#/components/schemas/Metric" - }, - "type": "array" - }, - "savedVisualizationId": { - "description": "Saved visualization ID.", - "type": "string" - }, - "suggestions": { - "description": "Suggestions for next steps", - "items": { - "$ref": "#/components/schemas/Suggestion" - }, - "type": "array" - }, - "title": { - "description": "Proposed title of the new visualization", - "example": "Revenue by Country", - "type": "string" - }, - "visualizationType": { - "description": "Visualization type requested in question", - "enum": [ - "TABLE", - "HEADLINE", - "BAR", - "LINE", - "PIE", - "COLUMN" - ], - "example": "TABLE", - "type": "string" - } - }, - "required": [ - "dimensionality", - "filters", - "id", - "metrics", - "suggestions", - "title", - "visualizationType" - ], - "type": "object" - }, - "CreatedVisualizations": { - "description": "Visualization definitions created by AI.", - "properties": { - "objects": { - "description": "List of created visualization objects", - "items": { - "$ref": "#/components/schemas/CreatedVisualization" - }, - "type": "array" - }, - "reasoning": { - "description": "DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.", - "type": "string" - }, - "suggestions": { - "description": "List of suggestions for next steps. Filled when no visualization was created, suggests alternatives.", - "items": { - "$ref": "#/components/schemas/Suggestion" - }, - "type": "array" - } - }, - "required": [ - "objects", - "reasoning", - "suggestions" - ], - "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": { - "dim2": { - "measureGroup": "m1", - "status": "lost" - } - }, - "properties": { - "properties": { - "additionalProperties": { - "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": "{\"status\":\"lost\",\"measureGroup\":\"m1\"}", - "type": "string" - }, - "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": { - "measureGroup": "m1", - "status": "lost" - }, - "type": "object" - } - }, - "required": [ - "properties" - ], - "type": "object" - }, - "DataColumnLocators": { - "description": "Data column locators for the values.", - "properties": { - "properties": { - "additionalProperties": { - "$ref": "#/components/schemas/DataColumnLocator" - }, - "description": "Mapping from dimensions to data column locators.", - "example": { - "dim2": { - "measureGroup": "m1", - "status": "lost" + "required" : [ "conditions", "measure" ], + "type" : "object" + } + }, + "required" : [ "compoundMeasureValueFilter" ], + "type" : "object" + }, + "CreatedVisualization" : { + "description" : "List of created visualization objects", + "properties" : { + "dimensionality" : { + "description" : "List of attributes representing the dimensionality of the new visualization", + "items" : { + "$ref" : "#/components/schemas/DimAttribute" + }, + "type" : "array" + }, + "filters" : { + "description" : "List of filters to be applied to the new visualization", + "items" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/AttributeNegativeFilter" + }, { + "$ref" : "#/components/schemas/AttributePositiveFilter" + }, { + "$ref" : "#/components/schemas/DateAbsoluteFilter" + }, { + "$ref" : "#/components/schemas/DateRelativeFilter" + }, { + "$ref" : "#/components/schemas/RankingFilter" + } ] + }, + "type" : "array" + }, + "id" : { + "description" : "Proposed ID of the new visualization", + "example" : "revenue_by_country", + "type" : "string" + }, + "metrics" : { + "description" : "List of metrics to be used in the new visualization", + "items" : { + "$ref" : "#/components/schemas/Metric" + }, + "type" : "array" + }, + "savedVisualizationId" : { + "description" : "Saved visualization ID.", + "type" : "string" + }, + "suggestions" : { + "description" : "Suggestions for next steps", + "items" : { + "$ref" : "#/components/schemas/Suggestion" + }, + "type" : "array" + }, + "title" : { + "description" : "Proposed title of the new visualization", + "example" : "Revenue by Country", + "type" : "string" + }, + "visualizationType" : { + "description" : "Visualization type requested in question", + "enum" : [ "TABLE", "HEADLINE", "BAR", "LINE", "PIE", "COLUMN" ], + "example" : "TABLE", + "type" : "string" + } + }, + "required" : [ "dimensionality", "filters", "id", "metrics", "suggestions", "title", "visualizationType" ], + "type" : "object" + }, + "CreatedVisualizations" : { + "description" : "Visualization definitions created by AI.", + "properties" : { + "objects" : { + "description" : "List of created visualization objects", + "items" : { + "$ref" : "#/components/schemas/CreatedVisualization" + }, + "type" : "array" + }, + "reasoning" : { + "description" : "DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.", + "type" : "string" + }, + "suggestions" : { + "description" : "List of suggestions for next steps. Filled when no visualization was created, suggests alternatives.", + "items" : { + "$ref" : "#/components/schemas/Suggestion" + }, + "type" : "array" + } + }, + "required" : [ "objects", "reasoning", "suggestions" ], + "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" : { + "dim2" : { + "measureGroup" : "m1", + "status" : "lost" + } + }, + "properties" : { + "properties" : { + "additionalProperties" : { + "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" : "{\"status\":\"lost\",\"measureGroup\":\"m1\"}", + "type" : "string" + }, + "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" : { + "measureGroup" : "m1", + "status" : "lost" + }, + "type" : "object" + } + }, + "required" : [ "properties" ], + "type" : "object" + }, + "DataColumnLocators" : { + "description" : "Data column locators for the values.", + "properties" : { + "properties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/DataColumnLocator" + }, + "description" : "Mapping from dimensions to data column locators.", + "example" : { + "dim2" : { + "measureGroup" : "m1", + "status" : "lost" } }, - "type": "object" + "type" : "object" + } + }, + "type" : "object" + }, + "DatabaseInstance" : { + "description" : "A single AI Lake Database instance", + "properties" : { + "id" : { + "description" : "Id of the AI Lake Database instance", + "type" : "string" + }, + "name" : { + "description" : "Name of the AI Lake Database instance", + "type" : "string" + }, + "storageIds" : { + "description" : "Set of ids of the storage instances this database instance should access.", + "items" : { + "description" : "Set of ids of the storage instances this database instance should access.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "id", "name", "storageIds" ], + "type" : "object" + }, + "DateAbsoluteFilter" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Filter" + }, { + "properties" : { + "from" : { + "type" : "string" + }, + "to" : { + "type" : "string" + }, + "using" : { + "type" : "string" + } + }, + "type" : "object" + } ], + "required" : [ "from", "to", "using" ], + "type" : "object" + }, + "DateFilter" : { + "description" : "Abstract filter definition type for dates.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AbsoluteDateFilter" + }, { + "$ref" : "#/components/schemas/RelativeDateFilter" + } ], + "type" : "object" + }, + "DateRelativeFilter" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Filter" + }, { + "properties" : { + "from" : { + "format" : "int32", + "type" : "integer" + }, + "granularity" : { + "enum" : [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], + "type" : "string" + }, + "to" : { + "format" : "int32", + "type" : "integer" + }, + "using" : { + "type" : "string" + } + }, + "type" : "object" + } ], + "required" : [ "from", "granularity", "to", "using" ], + "type" : "object" + }, + "DependsOn" : { + "allOf" : [ { + "$ref" : "#/components/schemas/DependsOnItem" + }, { + "properties" : { + "complementFilter" : { + "default" : false, + "description" : "Inverse filtering mode.", + "type" : "boolean" + }, + "label" : { + "description" : "Specifies on which label the filter depends on.", + "type" : "string" + }, + "values" : { + "description" : "Specifies values of the label for element filtering.", + "items" : { + "nullable" : true, + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + } ], + "description" : "Filter definition type specified by label and values.", + "required" : [ "label", "values" ], + "type" : "object" + }, + "DependsOnDateFilter" : { + "allOf" : [ { + "$ref" : "#/components/schemas/DependsOnItem" + }, { + "properties" : { + "dateFilter" : { + "$ref" : "#/components/schemas/DateFilter" + } + }, + "type" : "object" + } ], + "description" : "Filter definition type for dates.", + "required" : [ "dateFilter" ], + "type" : "object" + }, + "DependsOnItem" : { + "nullable" : true, + "type" : "object" + }, + "DimAttribute" : { + "description" : "List of attributes representing the dimensionality of the new visualization", + "properties" : { + "id" : { + "description" : "ID of the object", + "example" : "country", + "type" : "string" + }, + "title" : { + "description" : "Title of attribute.", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "attribute" ], + "example" : "attribute", + "type" : "string" + } + }, + "required" : [ "id", "title", "type" ], + "type" : "object" + }, + "Dimension" : { + "description" : "Single dimension description.", + "properties" : { + "itemIdentifiers" : { + "description" : "List of items in current dimension. Can reference 'localIdentifier' from 'AttributeItem', or special pseudo attribute \"measureGroup\" representing list of metrics.", + "example" : [ "attribute_1", "measureGroup" ], + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "localIdentifier" : { + "description" : "Dimension identification within requests. Other entities can reference this dimension by this value.", + "example" : "firstDimension", + "pattern" : "^[.a-zA-Z0-9_-]+$", + "type" : "string" + }, + "sorting" : { + "description" : "List of sorting rules. From most relevant to least relevant (less relevant rule is applied, when more relevant rule compares items as equal).", + "items" : { + "$ref" : "#/components/schemas/SortKey" + }, + "type" : "array" + } + }, + "required" : [ "itemIdentifiers" ], + "type" : "object" + }, + "DimensionHeader" : { + "description" : "Contains the dimension-specific header information.", + "properties" : { + "headerGroups" : { + "description" : "An array containing header groups.", + "items" : { + "$ref" : "#/components/schemas/HeaderGroup" + }, + "type" : "array" + } + }, + "required" : [ "headerGroups" ], + "type" : "object" + }, + "Element" : { + "description" : "List of returned elements.", + "properties" : { + "primaryTitle" : { + "description" : "Title of primary label of attribute owning requested label, null if the title is null or the primary label is excluded", + "type" : "string" + }, + "title" : { + "description" : "Title of requested label.", + "type" : "string" + } + }, + "required" : [ "primaryTitle", "title" ], + "type" : "object" + }, + "ElementsRequest" : { + "properties" : { + "cacheId" : { + "description" : "If specified, the element data will be taken from the result with the same cacheId if it is available.", + "type" : "string" + }, + "complementFilter" : { + "default" : false, + "description" : "Inverse filters:\n* ```false``` - return items matching ```patternFilter``` and ```exactFilter```\n* ```true``` - return items not matching ```patternFilter``` and ```exactFilter```", + "type" : "boolean" + }, + "dataSamplingPercentage" : { + "default" : 100.0, + "deprecated" : true, + "description" : "Specifies percentage of source table data scanned during the computation. This field is deprecated and is no longer used during the elements computation.", + "format" : "float", + "type" : "number" + }, + "dependsOn" : { + "description" : "Return only items that are not filtered-out by the parent filters.", + "items" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/DependsOn" + }, { + "$ref" : "#/components/schemas/DependsOnDateFilter" + } ] + }, + "type" : "array" + }, + "exactFilter" : { + "description" : "Return only items, whose ```label``` title exactly matches one of ```filter```.", + "items" : { + "nullable" : true, + "type" : "string" + }, + "type" : "array" + }, + "excludePrimaryLabel" : { + "default" : false, + "description" : "Excludes items from the result that differ only by primary label\n* ```false``` - return items with distinct primary label\n* ```true``` - return items with distinct requested label", + "type" : "boolean" + }, + "filterBy" : { + "$ref" : "#/components/schemas/FilterBy" + }, + "label" : { + "description" : "Requested label.", + "example" : "label_id", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "patternFilter" : { + "description" : "Return only items, whose ```label``` title case insensitively contains ```filter``` as substring.", + "type" : "string" + }, + "sortOrder" : { + "description" : "Sort order of returned items.\nItems are sorted by ```label``` title. If no sort order is specified then attribute's ```sortDirection``` is used, which is ASC by default", + "enum" : [ "ASC", "DESC" ], + "type" : "string" + }, + "validateBy" : { + "description" : "Return only items that are computable on metric.", + "items" : { + "$ref" : "#/components/schemas/ValidateByItem" + }, + "type" : "array" + } + }, + "required" : [ "label" ], + "type" : "object" + }, + "ElementsResponse" : { + "description" : "Entity holding list of sorted & filtered label elements, related primary label of attribute owning requested label and paging.", + "properties" : { + "cacheId" : { + "description" : "The client can use this in subsequent requests (like paging or search) to get results from the same point in time as the previous request. This is useful when the underlying data source has caches disabled and the client wants to avoid seeing inconsistent results and to also avoid excessive queries to the database itself.", + "type" : "string" + }, + "elements" : { + "description" : "List of returned elements.", + "items" : { + "$ref" : "#/components/schemas/Element" + }, + "type" : "array" + }, + "format" : { + "$ref" : "#/components/schemas/AttributeFormat" + }, + "granularity" : { + "description" : "Granularity of requested label in case of date attribute", + "enum" : [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], + "type" : "string" + }, + "paging" : { + "$ref" : "#/components/schemas/Paging" + }, + "primaryLabel" : { + "$ref" : "#/components/schemas/RestApiIdentifier" + } + }, + "required" : [ "elements", "paging", "primaryLabel" ], + "type" : "object" + }, + "ExecutionLinks" : { + "description" : "Links to the execution result.", + "properties" : { + "executionResult" : { + "description" : "Link to the result data.", + "type" : "string" + } + }, + "required" : [ "executionResult" ], + "type" : "object" + }, + "ExecutionResponse" : { + "description" : "Response to AFM execution request body", + "properties" : { + "dimensions" : { + "description" : "Dimensions of the result", + "items" : { + "$ref" : "#/components/schemas/ResultDimension" + }, + "type" : "array" + }, + "links" : { + "$ref" : "#/components/schemas/ExecutionLinks" } }, - "type": "object" + "required" : [ "dimensions", "links" ], + "type" : "object" }, - "DatabaseInstance": { - "description": "A single AI Lake Database instance", - "properties": { - "id": { - "description": "Id of the AI Lake Database instance", - "type": "string" + "ExecutionResult" : { + "description" : "Contains the result of an AFM execution.", + "properties" : { + "data" : { + "description" : "A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values.", + "example" : [ [ 1.0, 2.5 ], [ -1.3, 3.14 ] ], + "items" : { + "type" : "object" + }, + "type" : "array" }, - "name": { - "description": "Name of the AI Lake Database instance", - "type": "string" + "dimensionHeaders" : { + "description" : "An array containing dimension headers. The size of the array corresponds to the number of dimensions. Their order corresponds to the dimension order in the execution result spec.", + "items" : { + "$ref" : "#/components/schemas/DimensionHeader" + }, + "type" : "array" }, - "storageIds": { - "description": "Set of ids of the storage instances this database instance should access.", - "items": { - "description": "Set of ids of the storage instances this database instance should access.", - "type": "string" + "grandTotals" : { + "items" : { + "$ref" : "#/components/schemas/ExecutionResultGrandTotal" }, - "type": "array", - "uniqueItems": true + "type" : "array" + }, + "metadata" : { + "$ref" : "#/components/schemas/ExecutionResultMetadata" + }, + "paging" : { + "$ref" : "#/components/schemas/ExecutionResultPaging" + } + }, + "required" : [ "data", "dimensionHeaders", "grandTotals", "metadata", "paging" ], + "type" : "object" + }, + "ExecutionResultDataSourceMessage" : { + "description" : "A piece of extra information related to the results (e.g. debug information, warnings, etc.).", + "properties" : { + "correlationId" : { + "description" : "Id correlating different pieces of supplementary info together.", + "type" : "string" + }, + "data" : { + "description" : "Data of this particular supplementary info item: a free-form JSON specific to the particular supplementary info item type.", + "type" : "object" + }, + "source" : { + "description" : "Information about what part of the system created this piece of supplementary info.", + "type" : "string" + }, + "type" : { + "description" : "Type of the supplementary info instance. There are currently no well-known values for this, but there might be some in the future.", + "type" : "string" + } + }, + "required" : [ "correlationId", "source", "type" ], + "type" : "object" + }, + "ExecutionResultGrandTotal" : { + "description" : "Contains the data of grand totals with the same dimensions.", + "properties" : { + "data" : { + "description" : "A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values.", + "example" : [ [ 1.0, 2.5 ], [ -1.3, 3.14 ] ], + "items" : { + "type" : "object" + }, + "type" : "array" + }, + "dimensionHeaders" : { + "description" : "Contains headers for a subset of `totalDimensions` in which the totals are grand totals.", + "items" : { + "$ref" : "#/components/schemas/DimensionHeader" + }, + "type" : "array" + }, + "totalDimensions" : { + "description" : "Dimensions of the grand totals.", + "items" : { + "description" : "Dimensions of the grand totals.", + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ "data", "dimensionHeaders", "totalDimensions" ], + "type" : "object" + }, + "ExecutionResultHeader" : { + "description" : "Abstract execution result header", + "oneOf" : [ { + "$ref" : "#/components/schemas/AttributeExecutionResultHeader" + }, { + "$ref" : "#/components/schemas/MeasureExecutionResultHeader" + }, { + "$ref" : "#/components/schemas/TotalExecutionResultHeader" + } ], + "type" : "object" + }, + "ExecutionResultMetadata" : { + "description" : "Additional metadata for the particular execution result.", + "properties" : { + "dataSourceMessages" : { + "description" : "Additional information sent by the underlying data source.", + "items" : { + "$ref" : "#/components/schemas/ExecutionResultDataSourceMessage" + }, + "type" : "array" + } + }, + "required" : [ "dataSourceMessages" ], + "type" : "object" + }, + "ExecutionResultPaging" : { + "description" : "A paging information related to the data presented in the execution result. These paging information are multi-dimensional.", + "properties" : { + "count" : { + "description" : "A count of the returned results in every dimension.", + "example" : [ 2, 2 ], + "items" : { + "format" : "int32", + "type" : "integer" + }, + "type" : "array" + }, + "offset" : { + "description" : "The offset of the results returned in every dimension.", + "example" : [ 0, 0 ], + "items" : { + "format" : "int32", + "type" : "integer" + }, + "type" : "array" + }, + "total" : { + "description" : "A total count of the results in every dimension.", + "example" : [ 2, 2 ], + "items" : { + "format" : "int32", + "type" : "integer" + }, + "type" : "array" + } + }, + "required" : [ "count", "offset", "total" ], + "type" : "object" + }, + "ExecutionSettings" : { + "description" : "Various settings affecting the process of AFM execution or its result", + "properties" : { + "dataSamplingPercentage" : { + "description" : "Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.", + "exclusiveMaximum" : true, + "exclusiveMinimum" : true, + "format" : "float", + "maximum" : 100, + "minimum" : 0, + "type" : "number" + }, + "timestamp" : { + "description" : "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.", + "format" : "date-time", + "type" : "string" + } + }, + "type" : "object" + }, + "FailedOperation" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Operation" + }, { + "properties" : { + "error" : { + "$ref" : "#/components/schemas/OperationError" + } + }, + "type" : "object" + } ], + "description" : "Operation that has failed", + "required" : [ "error", "id", "kind" ], + "type" : "object" + }, + "Filter" : { + "description" : "List of filters to be applied to the new visualization", + "type" : "object" + }, + "FilterBy" : { + "description" : "Specifies what is used for filtering.", + "properties" : { + "labelType" : { + "default" : "REQUESTED", + "description" : "Specifies which label is used for filtering - primary or requested.", + "enum" : [ "PRIMARY", "REQUESTED" ], + "type" : "string" + } + }, + "type" : "object" + }, + "FilterDefinition" : { + "description" : "Abstract filter definition type", + "oneOf" : [ { + "$ref" : "#/components/schemas/InlineFilterDefinition" + }, { + "$ref" : "#/components/schemas/RankingFilter" + }, { + "$ref" : "#/components/schemas/ComparisonMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/RangeMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/CompoundMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/AbsoluteDateFilter" + }, { + "$ref" : "#/components/schemas/RelativeDateFilter" + }, { + "$ref" : "#/components/schemas/NegativeAttributeFilter" + }, { + "$ref" : "#/components/schemas/PositiveAttributeFilter" + } ], + "type" : "object" + }, + "FilterDefinitionForSimpleMeasure" : { + "description" : "Abstract filter definition type for simple metric.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DateFilter" + }, { + "$ref" : "#/components/schemas/AttributeFilter" + } ], + "type" : "object" + }, + "ForecastRequest" : { + "properties" : { + "confidenceLevel" : { + "default" : 0.95, + "description" : "Confidence interval boundary value.", + "exclusiveMaximum" : true, + "exclusiveMinimum" : true, + "format" : "float", + "maximum" : 1.0, + "minimum" : 0.0, + "type" : "number" + }, + "forecastPeriod" : { + "description" : "Number of future periods that should be forecasted", + "format" : "int32", + "type" : "integer" + }, + "seasonal" : { + "default" : false, + "description" : "Whether the input data is seasonal", + "type" : "boolean" + } + }, + "required" : [ "forecastPeriod" ], + "type" : "object" + }, + "ForecastResult" : { + "properties" : { + "attribute" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "lowerBound" : { + "items" : { + "nullable" : true, + "type" : "number" + }, + "type" : "array" + }, + "origin" : { + "items" : { + "nullable" : true, + "type" : "number" + }, + "type" : "array" + }, + "prediction" : { + "items" : { + "nullable" : true, + "type" : "number" + }, + "type" : "array" + }, + "upperBound" : { + "items" : { + "nullable" : true, + "type" : "number" + }, + "type" : "array" + } + }, + "required" : [ "attribute", "lowerBound", "origin", "prediction", "upperBound" ], + "type" : "object" + }, + "FoundObjects" : { + "description" : "List of objects found by similarity search and post-processed by LLM.", + "properties" : { + "objects" : { + "description" : "List of objects found with a similarity search.", + "items" : { + "$ref" : "#/components/schemas/SearchResultObject" + }, + "type" : "array" + }, + "reasoning" : { + "description" : "DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.", + "type" : "string" + } + }, + "required" : [ "objects", "reasoning" ], + "type" : "object" + }, + "GeoAreaConfig" : { + "description" : "Configuration specific to geo area labels.", + "properties" : { + "collection" : { + "$ref" : "#/components/schemas/GeoCollectionIdentifier" + } + }, + "required" : [ "collection" ], + "type" : "object" + }, + "GeoCollectionIdentifier" : { + "properties" : { + "id" : { + "description" : "Geo collection identifier.", + "maxLength" : 255, + "type" : "string" + }, + "kind" : { + "default" : "STATIC", + "description" : "Type of geo collection.", + "enum" : [ "STATIC", "CUSTOM" ], + "type" : "string" } }, - "required": [ - "id", - "name", - "storageIds" - ], - "type": "object" + "required" : [ "id" ], + "type" : "object" }, - "DateAbsoluteFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/Filter" + "GetQualityIssuesResponse" : { + "properties" : { + "issues" : { + "description" : "List of quality issues found in the workspace", + "items" : { + "$ref" : "#/components/schemas/QualityIssue" + }, + "type" : "array" }, - { - "properties": { - "from": { - "type": "string" + "status" : { + "description" : "Status of the latest triggered quality check process", + "enum" : [ "RUNNING", "SYNCING", "COMPLETED", "FAILED", "NOT_FOUND", "DISABLED" ], + "type" : "string" + }, + "updatedAt" : { + "description" : "Timestamp when the quality issues were last updated (ISO format)", + "type" : "string" + } + }, + "required" : [ "issues", "status" ], + "type" : "object" + }, + "HeaderGroup" : { + "description" : "Contains the information specific for a group of headers. These groups correlate to attributes and metric groups.", + "properties" : { + "headers" : { + "description" : "An array containing headers.", + "items" : { + "$ref" : "#/components/schemas/ExecutionResultHeader" + }, + "type" : "array" + } + }, + "required" : [ "headers" ], + "type" : "object" + }, + "InlineFilterDefinition" : { + "description" : "Filter in form of direct MAQL query.", + "properties" : { + "inline" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" }, - "to": { - "type": "string" + "filter" : { + "description" : "MAQL query representing the filter.", + "type" : "string" }, - "using": { - "type": "string" + "localIdentifier" : { + "type" : "string" + } + }, + "required" : [ "filter" ], + "type" : "object" + } + }, + "required" : [ "inline" ], + "type" : "object" + }, + "InlineMeasureDefinition" : { + "description" : "Metric defined by the raw MAQL query.", + "properties" : { + "inline" : { + "properties" : { + "maql" : { + "description" : "MAQL query defining the metric.", + "type" : "string" } }, - "type": "object" - } - ], - "required": [ - "from", - "to", - "using" - ], - "type": "object" - }, - "DateFilter": { - "description": "Abstract filter definition type for dates.", - "oneOf": [ - { - "$ref": "#/components/schemas/AbsoluteDateFilter" - }, - { - "$ref": "#/components/schemas/RelativeDateFilter" - } - ], - "type": "object" - }, - "DateRelativeFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/Filter" - }, - { - "properties": { - "from": { - "format": "int32", - "type": "integer" + "required" : [ "maql" ], + "type" : "object" + } + }, + "required" : [ "inline" ], + "type" : "object" + }, + "KeyDriversDimension" : { + "properties" : { + "attribute" : { + "$ref" : "#/components/schemas/RestApiIdentifier" + }, + "attributeName" : { + "type" : "string" + }, + "format" : { + "$ref" : "#/components/schemas/AttributeFormat" + }, + "granularity" : { + "enum" : [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], + "type" : "string" + }, + "label" : { + "$ref" : "#/components/schemas/RestApiIdentifier" + }, + "labelName" : { + "type" : "string" + }, + "valueType" : { + "enum" : [ "TEXT", "HYPERLINK", "GEO", "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", "IMAGE" ], + "type" : "string" + } + }, + "required" : [ "attribute", "attributeName", "label", "labelName" ], + "type" : "object" + }, + "KeyDriversRequest" : { + "properties" : { + "auxMetrics" : { + "description" : "Additional metrics to be included in the computation, but excluded from the analysis.", + "items" : { + "$ref" : "#/components/schemas/MeasureItem" + }, + "type" : "array" + }, + "metric" : { + "$ref" : "#/components/schemas/MeasureItem" + }, + "sortDirection" : { + "default" : "DESC", + "description" : "Sorting elements - ascending/descending order.", + "enum" : [ "ASC", "DESC" ], + "type" : "string" + } + }, + "required" : [ "metric" ], + "type" : "object" + }, + "KeyDriversResponse" : { + "properties" : { + "dimensions" : { + "items" : { + "$ref" : "#/components/schemas/KeyDriversDimension" + }, + "type" : "array" + }, + "links" : { + "$ref" : "#/components/schemas/ExecutionLinks" + } + }, + "required" : [ "dimensions", "links" ], + "type" : "object" + }, + "KeyDriversResult" : { + "properties" : { + "data" : { + "type" : "object" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "MeasureDefinition" : { + "description" : "Abstract metric definition type", + "oneOf" : [ { + "$ref" : "#/components/schemas/InlineMeasureDefinition" + }, { + "$ref" : "#/components/schemas/ArithmeticMeasureDefinition" + }, { + "$ref" : "#/components/schemas/SimpleMeasureDefinition" + }, { + "$ref" : "#/components/schemas/PopMeasureDefinition" + } ], + "type" : "object" + }, + "MeasureExecutionResultHeader" : { + "properties" : { + "measureHeader" : { + "$ref" : "#/components/schemas/MeasureResultHeader" + } + }, + "required" : [ "measureHeader" ], + "type" : "object" + }, + "MeasureGroupHeaders" : { + "description" : "Measure group headers", + "properties" : { + "measureGroupHeaders" : { + "items" : { + "$ref" : "#/components/schemas/MeasureHeader" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "MeasureHeader" : { + "properties" : { + "format" : { + "description" : "Format to be used to format the measure data.", + "type" : "string" + }, + "localIdentifier" : { + "description" : "Local identifier of the measure this header relates to.", + "type" : "string" + }, + "name" : { + "description" : "Name of the measure.", + "type" : "string" + } + }, + "required" : [ "localIdentifier" ], + "type" : "object" + }, + "MeasureItem" : { + "description" : "Metric is a quantity that is calculated from the data.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/MeasureDefinition" + }, + "localIdentifier" : { + "description" : "Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.", + "example" : "metric_1", + "pattern" : "^[.a-zA-Z0-9_-]+$", + "type" : "string" + } + }, + "required" : [ "definition", "localIdentifier" ], + "type" : "object" + }, + "MeasureResultHeader" : { + "description" : "Header containing the information related to metrics.", + "properties" : { + "measureIndex" : { + "description" : "Metric index. Starts at 0.", + "example" : 0, + "format" : "int32", + "type" : "integer" + } + }, + "required" : [ "measureIndex" ], + "type" : "object" + }, + "MeasureValueCondition" : { + "description" : "A condition for filtering by measure value. Can be either a comparison or a range condition.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ComparisonCondition" + }, { + "$ref" : "#/components/schemas/RangeCondition" + } ], + "type" : "object" + }, + "MeasureValueFilter" : { + "description" : "Abstract filter definition type filtering by the value of the metric.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ComparisonMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/RangeMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/CompoundMeasureValueFilter" + } ], + "type" : "object" + }, + "MemoryItemCreatedByUsers" : { + "properties" : { + "reasoning" : { + "description" : "Reasoning for error states", + "type" : "string" + }, + "users" : { + "description" : "Users who created memory item", + "items" : { + "$ref" : "#/components/schemas/MemoryItemUser" + }, + "type" : "array" + } + }, + "required" : [ "reasoning", "users" ], + "type" : "object" + }, + "MemoryItemUser" : { + "description" : "Users who created memory item", + "properties" : { + "firstname" : { + "description" : "First name of the user who created memory item", + "type" : "string" + }, + "lastname" : { + "description" : "Last name of the user who created memory item", + "type" : "string" + }, + "userId" : { + "description" : "User ID of the user who created memory item", + "type" : "string" + } + }, + "required" : [ "firstname", "lastname", "userId" ], + "type" : "object" + }, + "Metric" : { + "description" : "List of metrics to be used in the new visualization", + "properties" : { + "aggFunction" : { + "description" : "Agg function. Empty if a stored metric is used.", + "enum" : [ "COUNT", "SUM", "MIN", "MAX", "AVG", "MEDIAN" ], + "type" : "string" + }, + "id" : { + "description" : "ID of the object", + "example" : "revenue", + "type" : "string" + }, + "title" : { + "description" : "Title of metric.", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "metric", "fact", "attribute" ], + "example" : "metric", + "type" : "string" + } + }, + "required" : [ "id", "title", "type" ], + "type" : "object" + }, + "MetricValueChange" : { + "description" : "Individual change analysis data item", + "properties" : { + "attributeName" : { + "description" : "The name of the attribute being analyzed", + "type" : "string" + }, + "attributeValue" : { + "description" : "The value of the attribute being analyzed", + "type" : "string" + }, + "attributeValuesChangeMean" : { + "description" : "The mean of attribute value changes for the attribute being analyzed", + "format" : "double", + "type" : "number" + }, + "attributeValuesChangeStd" : { + "description" : "The standard deviation of attribute value changes for the attribute being analyzed", + "format" : "double", + "type" : "number" + }, + "isSignificantChange" : { + "description" : "Whether the change is statistically significant", + "type" : "boolean" + }, + "metricValueDelta" : { + "description" : "The delta between analyzed and reference periods", + "format" : "double", + "type" : "number" + }, + "metricValueDeltaAbs" : { + "description" : "The absolute delta between analyzed and reference periods", + "format" : "double", + "type" : "number" + }, + "metricValueInAnalyzedPeriod" : { + "description" : "The metric value in the analyzed period", + "format" : "double", + "type" : "number" + }, + "metricValueInReferencePeriod" : { + "description" : "The metric value in the reference period", + "format" : "double", + "type" : "number" + }, + "overallMetricValueInAnalyzedPeriod" : { + "description" : "The overall metric value in the analyzed period", + "format" : "double", + "type" : "number" + }, + "overallMetricValueInReferencePeriod" : { + "description" : "The overall metric value in the reference period", + "format" : "double", + "type" : "number" + } + }, + "required" : [ "attributeName", "attributeValue", "attributeValuesChangeMean", "attributeValuesChangeStd", "isSignificantChange", "metricValueDelta", "metricValueDeltaAbs", "metricValueInAnalyzedPeriod", "metricValueInReferencePeriod", "overallMetricValueInAnalyzedPeriod", "overallMetricValueInReferencePeriod" ], + "type" : "object" + }, + "NegativeAttributeFilter" : { + "description" : "Filter able to limit element values by label and related selected negated elements.", + "properties" : { + "negativeAttributeFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" }, - "granularity": { - "enum": [ - "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", - "MINUTE_OF_HOUR", - "HOUR_OF_DAY", - "DAY_OF_WEEK", - "DAY_OF_MONTH", - "DAY_OF_QUARTER", - "DAY_OF_YEAR", - "WEEK_OF_YEAR", - "MONTH_OF_YEAR", - "QUARTER_OF_YEAR", - "FISCAL_MONTH", - "FISCAL_QUARTER", - "FISCAL_YEAR" - ], - "type": "string" + "label" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "to": { - "format": "int32", - "type": "integer" + "localIdentifier" : { + "type" : "string" }, - "using": { - "type": "string" + "notIn" : { + "$ref" : "#/components/schemas/AttributeFilterElements" } }, - "type": "object" - } - ], - "required": [ - "from", - "granularity", - "to", - "using" - ], - "type": "object" - }, - "DependsOn": { - "allOf": [ - { - "$ref": "#/components/schemas/DependsOnItem" - }, - { - "properties": { - "complementFilter": { - "default": false, - "description": "Inverse filtering mode.", - "type": "boolean" - }, - "label": { - "description": "Specifies on which label the filter depends on.", - "type": "string" + "required" : [ "notIn", "label" ], + "type" : "object" + } + }, + "required" : [ "negativeAttributeFilter" ], + "type" : "object" + }, + "Operation" : { + "description" : "Represents a Long-Running Operation: a process that takes some time to complete.", + "discriminator" : { + "mapping" : { + "failed" : "#/components/schemas/FailedOperation", + "pending" : "#/components/schemas/PendingOperation", + "succeeded" : "#/components/schemas/SucceededOperation" + }, + "propertyName" : "status" + }, + "properties" : { + "id" : { + "description" : "Id of the operation", + "type" : "string" + }, + "kind" : { + "description" : "Type of the long-running operation. \n* `provision-database` — Provisioning of an AI Lake database. \n* `deprovision-database` — Deprovisioning (deletion) of an AI Lake database.\n", + "enum" : [ "provision-database", "deprovision-database" ], + "type" : "string" + }, + "status" : { + "type" : "string" + } + }, + "required" : [ "id", "kind", "status" ], + "type" : "object" + }, + "OperationError" : { + "description" : "Error information for a failed operation", + "properties" : { + "detail" : { + "description" : "Human-readable error details", + "type" : "string" + }, + "status" : { + "description" : "HTTP status code", + "format" : "int32", + "type" : "integer" + }, + "title" : { + "description" : "Human-readable error name", + "type" : "string" + } + }, + "required" : [ "detail", "status", "title" ], + "type" : "object" + }, + "OutlierDetectionRequest" : { + "properties" : { + "attributes" : { + "description" : "Attributes to be used in the computation.", + "items" : { + "$ref" : "#/components/schemas/AttributeItem" + }, + "type" : "array" + }, + "auxMeasures" : { + "description" : "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", + "items" : { + "$ref" : "#/components/schemas/MeasureItem" + }, + "type" : "array" + }, + "filters" : { + "description" : "Various filter types to filter the execution result.", + "items" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/AbstractMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/FilterDefinitionForSimpleMeasure" + }, { + "$ref" : "#/components/schemas/InlineFilterDefinition" + } ] + }, + "type" : "array" + }, + "granularity" : { + "description" : "Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).", + "enum" : [ "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], + "type" : "string" + }, + "measures" : { + "items" : { + "$ref" : "#/components/schemas/MeasureItem" + }, + "minItems" : 1, + "type" : "array" + }, + "sensitivity" : { + "description" : "Sensitivity level for outlier detection", + "enum" : [ "LOW", "MEDIUM", "HIGH" ], + "type" : "string" + } + }, + "required" : [ "attributes", "filters", "granularity", "measures", "sensitivity" ], + "type" : "object" + }, + "OutlierDetectionResponse" : { + "properties" : { + "links" : { + "$ref" : "#/components/schemas/ExecutionLinks" + } + }, + "required" : [ "links" ], + "type" : "object" + }, + "OutlierDetectionResult" : { + "properties" : { + "attribute" : { + "description" : "Attribute values for outlier detection results.", + "items" : { + "type" : "string" + }, + "nullable" : true, + "type" : "array" + }, + "values" : { + "additionalProperties" : { + "description" : "Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.", + "items" : { + "description" : "Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.", + "nullable" : true, + "type" : "number" }, - "values": { - "description": "Specifies values of the label for element filtering.", - "items": { - "nullable": true, - "type": "string" + "nullable" : true, + "type" : "array" + }, + "description" : "Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.", + "nullable" : true, + "type" : "object" + } + }, + "required" : [ "attribute", "values" ], + "type" : "object" + }, + "Paging" : { + "description" : "Current page description.", + "properties" : { + "count" : { + "description" : "Count of items in this page.", + "example" : 5, + "format" : "int32", + "type" : "integer" + }, + "next" : { + "description" : "Link to next page, or null if this is last page.", + "example" : "https://sample.gooddata.com/api/v1/actions/workspaces/sampleWorkspace/execution/collectLabelElements?label=sample.price&limit=5&offset=10", + "type" : "string" + }, + "offset" : { + "description" : "Offset of this page.", + "example" : 10, + "format" : "int32", + "type" : "integer" + }, + "total" : { + "description" : "Count of returnable items ignoring paging.", + "example" : 100, + "format" : "int32", + "type" : "integer" + } + }, + "required" : [ "count", "offset", "total" ], + "type" : "object" + }, + "PendingOperation" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Operation" + } ], + "description" : "Operation that is still pending", + "required" : [ "id", "kind" ], + "type" : "object" + }, + "PopDataset" : { + "description" : "Combination of the date data set to use and how many periods ago to calculate the previous period for.", + "properties" : { + "dataset" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierDataset" + }, + "periodsAgo" : { + "description" : "Number of periods ago to calculate the previous period for.", + "example" : 1, + "format" : "int32", + "type" : "integer" + } + }, + "required" : [ "dataset", "periodsAgo" ], + "type" : "object" + }, + "PopDatasetMeasureDefinition" : { + "description" : "Previous period type of metric.", + "properties" : { + "previousPeriodMeasure" : { + "properties" : { + "dateDatasets" : { + "description" : "Specification of which date data sets to use for determining the period to calculate the previous period for.", + "items" : { + "$ref" : "#/components/schemas/PopDataset" }, - "type": "array" + "type" : "array" + }, + "measureIdentifier" : { + "$ref" : "#/components/schemas/AfmLocalIdentifier" } }, - "type": "object" - } - ], - "description": "Filter definition type specified by label and values.", - "required": [ - "label", - "values" - ], - "type": "object" - }, - "DependsOnDateFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/DependsOnItem" - }, - { - "properties": { - "dateFilter": { - "$ref": "#/components/schemas/DateFilter" + "required" : [ "dateDatasets", "measureIdentifier" ], + "type" : "object" + } + }, + "required" : [ "previousPeriodMeasure" ], + "type" : "object" + }, + "PopDate" : { + "description" : "Combination of the date attribute to use and how many periods ago to calculate the PoP for.", + "properties" : { + "attribute" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierAttribute" + }, + "periodsAgo" : { + "description" : "Number of periods ago to calculate the previous period for.", + "example" : 1, + "format" : "int32", + "type" : "integer" + } + }, + "required" : [ "attribute", "periodsAgo" ], + "type" : "object" + }, + "PopDateMeasureDefinition" : { + "description" : "Period over period type of metric.", + "properties" : { + "overPeriodMeasure" : { + "properties" : { + "dateAttributes" : { + "description" : "Attributes to use for determining the period to calculate the PoP for.", + "items" : { + "$ref" : "#/components/schemas/PopDate" + }, + "type" : "array" + }, + "measureIdentifier" : { + "$ref" : "#/components/schemas/AfmLocalIdentifier" } }, - "type": "object" - } - ], - "description": "Filter definition type for dates.", - "required": [ - "dateFilter" - ], - "type": "object" - }, - "DependsOnItem": { - "nullable": true, - "type": "object" - }, - "DimAttribute": { - "description": "List of attributes representing the dimensionality of the new visualization", - "properties": { - "id": { - "description": "ID of the object", - "example": "country", - "type": "string" - }, - "title": { - "description": "Title of attribute.", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "attribute" - ], - "example": "attribute", - "type": "string" - } - }, - "required": [ - "id", - "title", - "type" - ], - "type": "object" - }, - "Dimension": { - "description": "Single dimension description.", - "properties": { - "itemIdentifiers": { - "description": "List of items in current dimension. Can reference 'localIdentifier' from 'AttributeItem', or special pseudo attribute \"measureGroup\" representing list of metrics.", - "example": [ - "attribute_1", - "measureGroup" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "localIdentifier": { - "description": "Dimension identification within requests. Other entities can reference this dimension by this value.", - "example": "firstDimension", - "pattern": "^[.a-zA-Z0-9_-]+$", - "type": "string" - }, - "sorting": { - "description": "List of sorting rules. From most relevant to least relevant (less relevant rule is applied, when more relevant rule compares items as equal).", - "items": { - "$ref": "#/components/schemas/SortKey" - }, - "type": "array" - } - }, - "required": [ - "itemIdentifiers" - ], - "type": "object" - }, - "DimensionHeader": { - "description": "Contains the dimension-specific header information.", - "properties": { - "headerGroups": { - "description": "An array containing header groups.", - "items": { - "$ref": "#/components/schemas/HeaderGroup" - }, - "type": "array" - } - }, - "required": [ - "headerGroups" - ], - "type": "object" - }, - "Element": { - "description": "List of returned elements.", - "properties": { - "primaryTitle": { - "description": "Title of primary label of attribute owning requested label, null if the title is null or the primary label is excluded", - "type": "string" - }, - "title": { - "description": "Title of requested label.", - "type": "string" - } - }, - "required": [ - "primaryTitle", - "title" - ], - "type": "object" - }, - "ElementsRequest": { - "properties": { - "cacheId": { - "description": "If specified, the element data will be taken from the result with the same cacheId if it is available.", - "type": "string" - }, - "complementFilter": { - "default": false, - "description": "Inverse filters:\n* ```false``` - return items matching ```patternFilter``` and ```exactFilter```\n* ```true``` - return items not matching ```patternFilter``` and ```exactFilter```", - "type": "boolean" - }, - "dataSamplingPercentage": { - "default": 100, - "deprecated": true, - "description": "Specifies percentage of source table data scanned during the computation. This field is deprecated and is no longer used during the elements computation.", - "format": "float", - "type": "number" - }, - "dependsOn": { - "description": "Return only items that are not filtered-out by the parent filters.", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/DependsOn" - }, - { - "$ref": "#/components/schemas/DependsOnDateFilter" - } - ] - }, - "type": "array" - }, - "exactFilter": { - "description": "Return only items, whose ```label``` title exactly matches one of ```filter```.", - "items": { - "nullable": true, - "type": "string" - }, - "type": "array" - }, - "excludePrimaryLabel": { - "default": false, - "description": "Excludes items from the result that differ only by primary label\n* ```false``` - return items with distinct primary label\n* ```true``` - return items with distinct requested label", - "type": "boolean" - }, - "filterBy": { - "$ref": "#/components/schemas/FilterBy" - }, - "label": { - "description": "Requested label.", - "example": "label_id", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "patternFilter": { - "description": "Return only items, whose ```label``` title case insensitively contains ```filter``` as substring.", - "type": "string" - }, - "sortOrder": { - "description": "Sort order of returned items.\nItems are sorted by ```label``` title. If no sort order is specified then attribute's ```sortDirection``` is used, which is ASC by default", - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - }, - "validateBy": { - "description": "Return only items that are computable on metric.", - "items": { - "$ref": "#/components/schemas/ValidateByItem" - }, - "type": "array" - } - }, - "required": [ - "label" - ], - "type": "object" - }, - "ElementsResponse": { - "description": "Entity holding list of sorted & filtered label elements, related primary label of attribute owning requested label and paging.", - "properties": { - "cacheId": { - "description": "The client can use this in subsequent requests (like paging or search) to get results from the same point in time as the previous request. This is useful when the underlying data source has caches disabled and the client wants to avoid seeing inconsistent results and to also avoid excessive queries to the database itself.", - "type": "string" - }, - "elements": { - "description": "List of returned elements.", - "items": { - "$ref": "#/components/schemas/Element" - }, - "type": "array" - }, - "format": { - "$ref": "#/components/schemas/AttributeFormat" - }, - "granularity": { - "description": "Granularity of requested label in case of date attribute", - "enum": [ - "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", - "MINUTE_OF_HOUR", - "HOUR_OF_DAY", - "DAY_OF_WEEK", - "DAY_OF_MONTH", - "DAY_OF_QUARTER", - "DAY_OF_YEAR", - "WEEK_OF_YEAR", - "MONTH_OF_YEAR", - "QUARTER_OF_YEAR", - "FISCAL_MONTH", - "FISCAL_QUARTER", - "FISCAL_YEAR" - ], - "type": "string" - }, - "paging": { - "$ref": "#/components/schemas/Paging" - }, - "primaryLabel": { - "$ref": "#/components/schemas/RestApiIdentifier" - } - }, - "required": [ - "elements", - "paging", - "primaryLabel" - ], - "type": "object" - }, - "ExecutionLinks": { - "description": "Links to the execution result.", - "properties": { - "executionResult": { - "description": "Link to the result data.", - "type": "string" - } - }, - "required": [ - "executionResult" - ], - "type": "object" - }, - "ExecutionResponse": { - "description": "Response to AFM execution request body", - "properties": { - "dimensions": { - "description": "Dimensions of the result", - "items": { - "$ref": "#/components/schemas/ResultDimension" - }, - "type": "array" - }, - "links": { - "$ref": "#/components/schemas/ExecutionLinks" - } - }, - "required": [ - "dimensions", - "links" - ], - "type": "object" - }, - "ExecutionResult": { - "description": "Contains the result of an AFM execution.", - "properties": { - "data": { - "description": "A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values.", - "example": [ - [ - 1, - 2.5 - ], - [ - -1.3, - 3.14 - ] - ], - "items": { - "type": "object" - }, - "type": "array" - }, - "dimensionHeaders": { - "description": "An array containing dimension headers. The size of the array corresponds to the number of dimensions. Their order corresponds to the dimension order in the execution result spec.", - "items": { - "$ref": "#/components/schemas/DimensionHeader" - }, - "type": "array" - }, - "grandTotals": { - "items": { - "$ref": "#/components/schemas/ExecutionResultGrandTotal" - }, - "type": "array" - }, - "metadata": { - "$ref": "#/components/schemas/ExecutionResultMetadata" - }, - "paging": { - "$ref": "#/components/schemas/ExecutionResultPaging" - } - }, - "required": [ - "data", - "dimensionHeaders", - "grandTotals", - "metadata", - "paging" - ], - "type": "object" - }, - "ExecutionResultDataSourceMessage": { - "description": "A piece of extra information related to the results (e.g. debug information, warnings, etc.).", - "properties": { - "correlationId": { - "description": "Id correlating different pieces of supplementary info together.", - "type": "string" - }, - "data": { - "description": "Data of this particular supplementary info item: a free-form JSON specific to the particular supplementary info item type.", - "type": "object" - }, - "source": { - "description": "Information about what part of the system created this piece of supplementary info.", - "type": "string" - }, - "type": { - "description": "Type of the supplementary info instance. There are currently no well-known values for this, but there might be some in the future.", - "type": "string" - } - }, - "required": [ - "correlationId", - "source", - "type" - ], - "type": "object" - }, - "ExecutionResultGrandTotal": { - "description": "Contains the data of grand totals with the same dimensions.", - "properties": { - "data": { - "description": "A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values.", - "example": [ - [ - 1, - 2.5 - ], - [ - -1.3, - 3.14 - ] - ], - "items": { - "type": "object" - }, - "type": "array" - }, - "dimensionHeaders": { - "description": "Contains headers for a subset of `totalDimensions` in which the totals are grand totals.", - "items": { - "$ref": "#/components/schemas/DimensionHeader" - }, - "type": "array" - }, - "totalDimensions": { - "description": "Dimensions of the grand totals.", - "items": { - "description": "Dimensions of the grand totals.", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "data", - "dimensionHeaders", - "totalDimensions" - ], - "type": "object" - }, - "ExecutionResultHeader": { - "description": "Abstract execution result header", - "oneOf": [ - { - "$ref": "#/components/schemas/AttributeExecutionResultHeader" - }, - { - "$ref": "#/components/schemas/MeasureExecutionResultHeader" - }, - { - "$ref": "#/components/schemas/TotalExecutionResultHeader" - } - ], - "type": "object" - }, - "ExecutionResultMetadata": { - "description": "Additional metadata for the particular execution result.", - "properties": { - "dataSourceMessages": { - "description": "Additional information sent by the underlying data source.", - "items": { - "$ref": "#/components/schemas/ExecutionResultDataSourceMessage" - }, - "type": "array" - } - }, - "required": [ - "dataSourceMessages" - ], - "type": "object" - }, - "ExecutionResultPaging": { - "description": "A paging information related to the data presented in the execution result. These paging information are multi-dimensional.", - "properties": { - "count": { - "description": "A count of the returned results in every dimension.", - "example": [ - 2, - 2 - ], - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "offset": { - "description": "The offset of the results returned in every dimension.", - "example": [ - 0, - 0 - ], - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "total": { - "description": "A total count of the results in every dimension.", - "example": [ - 2, - 2 - ], - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - } - }, - "required": [ - "count", - "offset", - "total" - ], - "type": "object" - }, - "ExecutionSettings": { - "description": "Various settings affecting the process of AFM execution or its result", - "properties": { - "dataSamplingPercentage": { - "description": "Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.", - "exclusiveMaximum": true, - "exclusiveMinimum": true, - "format": "float", - "maximum": 100, - "minimum": 0, - "type": "number" - }, - "timestamp": { - "description": "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "FailedOperation": { - "allOf": [ - { - "$ref": "#/components/schemas/Operation" - }, - { - "properties": { - "error": { - "$ref": "#/components/schemas/OperationError" + "required" : [ "dateAttributes", "measureIdentifier" ], + "type" : "object" + } + }, + "required" : [ "overPeriodMeasure" ], + "type" : "object" + }, + "PopMeasureDefinition" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/PopDatasetMeasureDefinition" + }, { + "$ref" : "#/components/schemas/PopDateMeasureDefinition" + } ], + "type" : "object" + }, + "PositiveAttributeFilter" : { + "description" : "Filter able to limit element values by label and related selected elements.", + "properties" : { + "positiveAttributeFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "in" : { + "$ref" : "#/components/schemas/AttributeFilterElements" + }, + "label" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "localIdentifier" : { + "type" : "string" } }, - "type": "object" - } - ], - "description": "Operation that has failed", - "required": [ - "error", - "id", - "kind" - ], - "type": "object" - }, - "Filter": { - "description": "List of filters to be applied to the new visualization", - "type": "object" - }, - "FilterBy": { - "description": "Specifies what is used for filtering.", - "properties": { - "labelType": { - "default": "REQUESTED", - "description": "Specifies which label is used for filtering - primary or requested.", - "enum": [ - "PRIMARY", - "REQUESTED" - ], - "type": "string" - } - }, - "type": "object" + "required" : [ "in", "label" ], + "type" : "object" + } + }, + "required" : [ "positiveAttributeFilter" ], + "type" : "object" + }, + "ProvisionDatabaseInstanceRequest" : { + "description" : "Request to provision a new AILake Database instance", + "properties" : { + "name" : { + "description" : "Name of the database instance", + "type" : "string" + }, + "storageIds" : { + "description" : "Set of ids of the storage instances this database instance should access.", + "items" : { + "description" : "Set of ids of the storage instances this database instance should access.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "name", "storageIds" ], + "type" : "object" + }, + "QualityIssue" : { + "description" : "List of quality issues (available when status is COMPLETED)", + "properties" : { + "code" : { + "description" : "Quality issue code", + "example" : "SIMILAR_NAMES", + "type" : "string" + }, + "detail" : { + "additionalProperties" : { + "description" : "Detailed information about the quality issue", + "type" : "object" + }, + "description" : "Detailed information about the quality issue", + "type" : "object" + }, + "id" : { + "description" : "Unique identifier for the quality issue", + "type" : "string" + }, + "objects" : { + "description" : "List of objects affected by this quality issue", + "items" : { + "$ref" : "#/components/schemas/QualityIssueObject" + }, + "type" : "array" + }, + "severity" : { + "description" : "Severity level", + "enum" : [ "WARNING", "INFO" ], + "type" : "string" + } + }, + "required" : [ "code", "detail", "id", "objects", "severity" ], + "type" : "object" }, - "FilterDefinition": { - "description": "Abstract filter definition type", - "oneOf": [ - { - "$ref": "#/components/schemas/InlineFilterDefinition" - }, - { - "$ref": "#/components/schemas/RankingFilter" + "QualityIssueObject" : { + "description" : "List of objects affected by this quality issue", + "properties" : { + "id" : { + "description" : "Object ID", + "example" : "revenue", + "type" : "string" }, - { - "$ref": "#/components/schemas/ComparisonMeasureValueFilter" + "title" : { + "description" : "Object title", + "example" : "Total Revenue", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "example" : "metric", + "type" : "string" + }, + "workspaceId" : { + "description" : "Workspace ID where the object belongs", + "example" : "demo", + "type" : "string" + } + }, + "required" : [ "id", "title", "type", "workspaceId" ], + "type" : "object" + }, + "QualityIssuesCalculationStatusResponse" : { + "properties" : { + "error" : { + "description" : "Error message (available when status is FAILED or NOT_FOUND)", + "type" : "string" }, - { - "$ref": "#/components/schemas/RangeMeasureValueFilter" + "issues" : { + "description" : "List of quality issues (available when status is COMPLETED)", + "items" : { + "$ref" : "#/components/schemas/QualityIssue" + }, + "type" : "array" }, - { - "$ref": "#/components/schemas/CompoundMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/AbsoluteDateFilter" - }, - { - "$ref": "#/components/schemas/RelativeDateFilter" - }, - { - "$ref": "#/components/schemas/NegativeAttributeFilter" - }, - { - "$ref": "#/components/schemas/PositiveAttributeFilter" - } - ], - "type": "object" - }, - "FilterDefinitionForSimpleMeasure": { - "description": "Abstract filter definition type for simple metric.", - "oneOf": [ - { - "$ref": "#/components/schemas/DateFilter" - }, - { - "$ref": "#/components/schemas/AttributeFilter" - } - ], - "type": "object" - }, - "ForecastRequest": { - "properties": { - "confidenceLevel": { - "default": 0.95, - "description": "Confidence interval boundary value.", - "exclusiveMaximum": true, - "exclusiveMinimum": true, - "format": "float", - "maximum": 1, - "minimum": 0, - "type": "number" - }, - "forecastPeriod": { - "description": "Number of future periods that should be forecasted", - "format": "int32", - "type": "integer" - }, - "seasonal": { - "default": false, - "description": "Whether the input data is seasonal", - "type": "boolean" - } - }, - "required": [ - "forecastPeriod" - ], - "type": "object" - }, - "ForecastResult": { - "properties": { - "attribute": { - "items": { - "type": "string" - }, - "type": "array" - }, - "lowerBound": { - "items": { - "nullable": true, - "type": "number" - }, - "type": "array" - }, - "origin": { - "items": { - "nullable": true, - "type": "number" - }, - "type": "array" - }, - "prediction": { - "items": { - "nullable": true, - "type": "number" - }, - "type": "array" - }, - "upperBound": { - "items": { - "nullable": true, - "type": "number" - }, - "type": "array" - } - }, - "required": [ - "attribute", - "lowerBound", - "origin", - "prediction", - "upperBound" - ], - "type": "object" - }, - "FoundObjects": { - "description": "List of objects found by similarity search and post-processed by LLM.", - "properties": { - "objects": { - "description": "List of objects found with a similarity search.", - "items": { - "$ref": "#/components/schemas/SearchResultObject" - }, - "type": "array" - }, - "reasoning": { - "description": "DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.", - "type": "string" - } - }, - "required": [ - "objects", - "reasoning" - ], - "type": "object" - }, - "GeoAreaConfig": { - "description": "Configuration specific to geo area labels.", - "properties": { - "collection": { - "$ref": "#/components/schemas/GeoCollectionIdentifier" - } - }, - "required": [ - "collection" - ], - "type": "object" - }, - "GeoCollectionIdentifier": { - "properties": { - "id": { - "description": "Geo collection identifier.", - "maxLength": 255, - "type": "string" - }, - "kind": { - "default": "STATIC", - "description": "Type of geo collection.", - "enum": [ - "STATIC", - "CUSTOM" - ], - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "GetQualityIssuesResponse": { - "properties": { - "issues": { - "description": "List of quality issues found in the workspace", - "items": { - "$ref": "#/components/schemas/QualityIssue" - }, - "type": "array" - }, - "status": { - "description": "Status of the latest triggered quality check process", - "enum": [ - "RUNNING", - "SYNCING", - "COMPLETED", - "FAILED", - "NOT_FOUND", - "DISABLED" - ], - "type": "string" - }, - "updatedAt": { - "description": "Timestamp when the quality issues were last updated (ISO format)", - "type": "string" - } - }, - "required": [ - "issues", - "status" - ], - "type": "object" - }, - "HeaderGroup": { - "description": "Contains the information specific for a group of headers. These groups correlate to attributes and metric groups.", - "properties": { - "headers": { - "description": "An array containing headers.", - "items": { - "$ref": "#/components/schemas/ExecutionResultHeader" - }, - "type": "array" - } - }, - "required": [ - "headers" - ], - "type": "object" - }, - "InlineFilterDefinition": { - "description": "Filter in form of direct MAQL query.", - "properties": { - "inline": { - "properties": { - "applyOnResult": { - "type": "boolean" + "status" : { + "description" : "Current status of the calculation", + "enum" : [ "RUNNING", "SYNCING", "COMPLETED", "FAILED", "NOT_FOUND", "DISABLED" ], + "type" : "string" + } + }, + "required" : [ "status" ], + "type" : "object" + }, + "RangeCondition" : { + "description" : "Condition that checks if the metric value is within a given range.", + "properties" : { + "range" : { + "properties" : { + "from" : { + "example" : 100, + "type" : "number" }, - "filter": { - "description": "MAQL query representing the filter.", - "type": "string" + "operator" : { + "enum" : [ "BETWEEN", "NOT_BETWEEN" ], + "example" : "BETWEEN", + "type" : "string" }, - "localIdentifier": { - "type": "string" + "to" : { + "example" : 999, + "type" : "number" } }, - "required": [ - "filter" - ], - "type": "object" - } - }, - "required": [ - "inline" - ], - "type": "object" - }, - "InlineMeasureDefinition": { - "description": "Metric defined by the raw MAQL query.", - "properties": { - "inline": { - "properties": { - "maql": { - "description": "MAQL query defining the metric.", - "type": "string" + "required" : [ "from", "operator", "to" ], + "type" : "object" + } + }, + "required" : [ "range" ], + "type" : "object" + }, + "RangeMeasureValueFilter" : { + "description" : "Filter the result by comparing specified metric to given range of values.", + "properties" : { + "rangeMeasureValueFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "dimensionality" : { + "description" : "References to the attributes to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "type" : "array" + }, + "from" : { + "example" : 100, + "type" : "number" + }, + "localIdentifier" : { + "type" : "string" + }, + "measure" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "operator" : { + "enum" : [ "BETWEEN", "NOT_BETWEEN" ], + "example" : "BETWEEN", + "type" : "string" + }, + "to" : { + "example" : 999, + "type" : "number" + }, + "treatNullValuesAs" : { + "description" : "A value that will be substituted for null values in the metric for the comparisons.", + "example" : 0, + "type" : "number" } }, - "required": [ - "maql" - ], - "type": "object" - } - }, - "required": [ - "inline" - ], - "type": "object" - }, - "KeyDriversDimension": { - "properties": { - "attribute": { - "$ref": "#/components/schemas/RestApiIdentifier" - }, - "attributeName": { - "type": "string" - }, - "format": { - "$ref": "#/components/schemas/AttributeFormat" - }, - "granularity": { - "enum": [ - "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", - "MINUTE_OF_HOUR", - "HOUR_OF_DAY", - "DAY_OF_WEEK", - "DAY_OF_MONTH", - "DAY_OF_QUARTER", - "DAY_OF_YEAR", - "WEEK_OF_YEAR", - "MONTH_OF_YEAR", - "QUARTER_OF_YEAR", - "FISCAL_MONTH", - "FISCAL_QUARTER", - "FISCAL_YEAR" - ], - "type": "string" - }, - "label": { - "$ref": "#/components/schemas/RestApiIdentifier" - }, - "labelName": { - "type": "string" - }, - "valueType": { - "enum": [ - "TEXT", - "HYPERLINK", - "GEO", - "GEO_LONGITUDE", - "GEO_LATITUDE", - "GEO_AREA", - "IMAGE" - ], - "type": "string" - } - }, - "required": [ - "attribute", - "attributeName", - "label", - "labelName" - ], - "type": "object" - }, - "KeyDriversRequest": { - "properties": { - "auxMetrics": { - "description": "Additional metrics to be included in the computation, but excluded from the analysis.", - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "type": "array" - }, - "metric": { - "$ref": "#/components/schemas/MeasureItem" - }, - "sortDirection": { - "default": "DESC", - "description": "Sorting elements - ascending/descending order.", - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - } - }, - "required": [ - "metric" - ], - "type": "object" - }, - "KeyDriversResponse": { - "properties": { - "dimensions": { - "items": { - "$ref": "#/components/schemas/KeyDriversDimension" - }, - "type": "array" - }, - "links": { - "$ref": "#/components/schemas/ExecutionLinks" - } - }, - "required": [ - "dimensions", - "links" - ], - "type": "object" - }, - "KeyDriversResult": { - "properties": { - "data": { - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "MeasureDefinition": { - "description": "Abstract metric definition type", - "oneOf": [ - { - "$ref": "#/components/schemas/InlineMeasureDefinition" - }, - { - "$ref": "#/components/schemas/ArithmeticMeasureDefinition" - }, - { - "$ref": "#/components/schemas/SimpleMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopMeasureDefinition" - } - ], - "type": "object" - }, - "MeasureExecutionResultHeader": { - "properties": { - "measureHeader": { - "$ref": "#/components/schemas/MeasureResultHeader" - } - }, - "required": [ - "measureHeader" - ], - "type": "object" - }, - "MeasureGroupHeaders": { - "description": "Measure group headers", - "properties": { - "measureGroupHeaders": { - "items": { - "$ref": "#/components/schemas/MeasureHeader" + "required" : [ "from", "operator", "to", "measure" ], + "type" : "object" + } + }, + "required" : [ "rangeMeasureValueFilter" ], + "type" : "object" + }, + "RankingFilter" : { + "description" : "Filter the result on top/bottom N values according to given metric(s).", + "properties" : { + "rankingFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "dimensionality" : { + "description" : "References to the attributes to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "type" : "array" + }, + "localIdentifier" : { + "type" : "string" + }, + "measures" : { + "description" : "References to the metrics to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "type" : "array" + }, + "operator" : { + "description" : "The type of ranking to use, TOP or BOTTOM.", + "enum" : [ "TOP", "BOTTOM" ], + "type" : "string" + }, + "value" : { + "description" : "Number of top/bottom values to filter.", + "example" : 5, + "format" : "int32", + "type" : "integer" + } }, - "type": "array" + "required" : [ "measures", "operator", "value" ], + "type" : "object" } }, - "type": "object" + "required" : [ "rankingFilter" ], + "type" : "object" }, - "MeasureHeader": { - "properties": { - "format": { - "description": "Format to be used to format the measure data.", - "type": "string" + "Reasoning" : { + "description" : "Reasoning wrapper containing steps taken during request handling.", + "properties" : { + "answer" : { + "description" : "Final answer/reasoning from the use case result.", + "type" : "string" + }, + "steps" : { + "description" : "Steps taken during processing, showing the AI's reasoning process.", + "items" : { + "$ref" : "#/components/schemas/ReasoningStep" + }, + "type" : "array" + } + }, + "required" : [ "steps" ], + "type" : "object" + }, + "ReasoningStep" : { + "description" : "Steps taken during processing, showing the AI's reasoning process.", + "properties" : { + "thoughts" : { + "description" : "Detailed thoughts/messages within this step.", + "items" : { + "$ref" : "#/components/schemas/Thought" + }, + "type" : "array" + }, + "title" : { + "description" : "Title describing this reasoning step.", + "type" : "string" + } + }, + "required" : [ "thoughts", "title" ], + "type" : "object" + }, + "RelativeDateFilter" : { + "description" : "A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both.", + "properties" : { + "relativeDateFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "boundedFilter" : { + "$ref" : "#/components/schemas/BoundedFilter" + }, + "dataset" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierDataset" + }, + "from" : { + "description" : "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago').", + "example" : -6, + "format" : "int32", + "type" : "integer" + }, + "granularity" : { + "description" : "Date granularity specifying particular date attribute in given dimension.", + "enum" : [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], + "example" : "DAY", + "type" : "string" + }, + "localIdentifier" : { + "type" : "string" + }, + "to" : { + "description" : "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...).", + "example" : 0, + "format" : "int32", + "type" : "integer" + } + }, + "required" : [ "from", "granularity", "to", "dataset" ], + "type" : "object" + } + }, + "required" : [ "relativeDateFilter" ], + "type" : "object" + }, + "ResolvedLlmEndpoint" : { + "properties" : { + "id" : { + "description" : "Endpoint Id", + "type" : "string" + }, + "title" : { + "description" : "Endpoint Title", + "type" : "string" + } + }, + "required" : [ "id", "title" ], + "type" : "object" + }, + "ResolvedLlmEndpoints" : { + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/ResolvedLlmEndpoint" + }, + "type" : "array" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "RestApiIdentifier" : { + "description" : "Object identifier.", + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "example" : "fact", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "ResultCacheMetadata" : { + "description" : "All execution result's metadata used for calculation including ExecutionResponse", + "properties" : { + "afm" : { + "$ref" : "#/components/schemas/AFM" + }, + "executionResponse" : { + "$ref" : "#/components/schemas/ExecutionResponse" + }, + "resultSize" : { + "format" : "int64", + "type" : "integer" + }, + "resultSpec" : { + "$ref" : "#/components/schemas/ResultSpec" + } + }, + "required" : [ "afm", "executionResponse", "resultSize", "resultSpec" ], + "type" : "object" + }, + "ResultDimension" : { + "description" : "Single result dimension", + "properties" : { + "headers" : { + "items" : { + "$ref" : "#/components/schemas/ResultDimensionHeader" + }, + "type" : "array" + }, + "localIdentifier" : { + "description" : "Local identifier of the dimension.", + "type" : "string" + } + }, + "required" : [ "headers", "localIdentifier" ], + "type" : "object" + }, + "ResultDimensionHeader" : { + "description" : "One of the headers in a result dimension.", + "oneOf" : [ { + "$ref" : "#/components/schemas/MeasureGroupHeaders" + }, { + "$ref" : "#/components/schemas/AttributeHeader" + } ], + "type" : "object" + }, + "ResultSpec" : { + "description" : "Specifies how the result data will be formatted (```dimensions```) and which additional data shall be computed (```totals```).", + "properties" : { + "dimensions" : { + "items" : { + "$ref" : "#/components/schemas/Dimension" + }, + "type" : "array" + }, + "totals" : { + "items" : { + "$ref" : "#/components/schemas/Total" + }, + "type" : "array" + } + }, + "required" : [ "dimensions" ], + "type" : "object" + }, + "RouteResult" : { + "description" : "Question -> Use Case routing. May contain final answer is a special use case is not required.", + "properties" : { + "reasoning" : { + "description" : "Explanation why LLM picked this use case.", + "type" : "string" + }, + "useCase" : { + "description" : "Use case where LLM routed based on question.", + "enum" : [ "INVALID", "GENERAL", "SEARCH", "CREATE_VISUALIZATION", "EXTEND_VISUALIZATION", "HOWTO", "CHANGE_ANALYSIS", "ALERT" ], + "type" : "string" + } + }, + "required" : [ "reasoning", "useCase" ], + "type" : "object" + }, + "SavedVisualization" : { + "description" : "Created and saved visualization IDs.", + "properties" : { + "createdVisualizationId" : { + "description" : "Created visualization ID.", + "type" : "string" + }, + "savedVisualizationId" : { + "description" : "Saved visualization ID.", + "type" : "string" + } + }, + "required" : [ "createdVisualizationId", "savedVisualizationId" ], + "type" : "object" + }, + "SearchRelationshipObject" : { + "properties" : { + "sourceObjectId" : { + "description" : "Source object ID.", + "type" : "string" + }, + "sourceObjectTitle" : { + "description" : "Source object title.", + "type" : "string" + }, + "sourceObjectType" : { + "description" : "Source object type, e.g. dashboard.", + "type" : "string" }, - "localIdentifier": { - "description": "Local identifier of the measure this header relates to.", - "type": "string" + "sourceWorkspaceId" : { + "description" : "Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located.", + "type" : "string" }, - "name": { - "description": "Name of the measure.", - "type": "string" + "targetObjectId" : { + "description" : "Target object ID.", + "type" : "string" + }, + "targetObjectTitle" : { + "description" : "Target object title.", + "type" : "string" + }, + "targetObjectType" : { + "description" : "Target object type, e.g. visualization.", + "type" : "string" + }, + "targetWorkspaceId" : { + "description" : "Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located.", + "type" : "string" } }, - "required": [ - "localIdentifier" - ], - "type": "object" + "required" : [ "sourceObjectId", "sourceObjectTitle", "sourceObjectType", "sourceWorkspaceId", "targetObjectId", "targetObjectTitle", "targetObjectType", "targetWorkspaceId" ], + "type" : "object" }, - "MeasureItem": { - "description": "Metric is a quantity that is calculated from the data.", - "properties": { - "definition": { - "$ref": "#/components/schemas/MeasureDefinition" - }, - "localIdentifier": { - "description": "Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.", - "example": "metric_1", - "pattern": "^[.a-zA-Z0-9_-]+$", - "type": "string" - } - }, - "required": [ - "definition", - "localIdentifier" - ], - "type": "object" - }, - "MeasureResultHeader": { - "description": "Header containing the information related to metrics.", - "properties": { - "measureIndex": { - "description": "Metric index. Starts at 0.", - "example": 0, - "format": "int32", - "type": "integer" - } - }, - "required": [ - "measureIndex" - ], - "type": "object" - }, - "MeasureValueCondition": { - "description": "A condition for filtering by measure value. Can be either a comparison or a range condition.", - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonCondition" - }, - { - "$ref": "#/components/schemas/RangeCondition" - } - ], - "type": "object" - }, - "MeasureValueFilter": { - "description": "Abstract filter definition type filtering by the value of the metric.", - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/RangeMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/CompoundMeasureValueFilter" - } - ], - "type": "object" - }, - "MemoryItemCreatedByUsers": { - "properties": { - "reasoning": { - "description": "Reasoning for error states", - "type": "string" - }, - "users": { - "description": "Users who created memory item", - "items": { - "$ref": "#/components/schemas/MemoryItemUser" - }, - "type": "array" - } - }, - "required": [ - "reasoning", - "users" - ], - "type": "object" - }, - "MemoryItemUser": { - "description": "Users who created memory item", - "properties": { - "firstname": { - "description": "First name of the user who created memory item", - "type": "string" - }, - "lastname": { - "description": "Last name of the user who created memory item", - "type": "string" - }, - "userId": { - "description": "User ID of the user who created memory item", - "type": "string" - } - }, - "required": [ - "firstname", - "lastname", - "userId" - ], - "type": "object" - }, - "Metric": { - "description": "List of metrics to be used in the new visualization", - "properties": { - "aggFunction": { - "description": "Agg function. Empty if a stored metric is used.", - "enum": [ - "COUNT", - "SUM", - "MIN", - "MAX", - "AVG", - "MEDIAN" - ], - "type": "string" - }, - "id": { - "description": "ID of the object", - "example": "revenue", - "type": "string" - }, - "title": { - "description": "Title of metric.", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "metric", - "fact", - "attribute" - ], - "example": "metric", - "type": "string" - } - }, - "required": [ - "id", - "title", - "type" - ], - "type": "object" - }, - "MetricValueChange": { - "description": "Individual change analysis data item", - "properties": { - "attributeName": { - "description": "The name of the attribute being analyzed", - "type": "string" - }, - "attributeValue": { - "description": "The value of the attribute being analyzed", - "type": "string" - }, - "attributeValuesChangeMean": { - "description": "The mean of attribute value changes for the attribute being analyzed", - "format": "double", - "type": "number" - }, - "attributeValuesChangeStd": { - "description": "The standard deviation of attribute value changes for the attribute being analyzed", - "format": "double", - "type": "number" - }, - "isSignificantChange": { - "description": "Whether the change is statistically significant", - "type": "boolean" - }, - "metricValueDelta": { - "description": "The delta between analyzed and reference periods", - "format": "double", - "type": "number" - }, - "metricValueDeltaAbs": { - "description": "The absolute delta between analyzed and reference periods", - "format": "double", - "type": "number" - }, - "metricValueInAnalyzedPeriod": { - "description": "The metric value in the analyzed period", - "format": "double", - "type": "number" - }, - "metricValueInReferencePeriod": { - "description": "The metric value in the reference period", - "format": "double", - "type": "number" - }, - "overallMetricValueInAnalyzedPeriod": { - "description": "The overall metric value in the analyzed period", - "format": "double", - "type": "number" - }, - "overallMetricValueInReferencePeriod": { - "description": "The overall metric value in the reference period", - "format": "double", - "type": "number" - } - }, - "required": [ - "attributeName", - "attributeValue", - "attributeValuesChangeMean", - "attributeValuesChangeStd", - "isSignificantChange", - "metricValueDelta", - "metricValueDeltaAbs", - "metricValueInAnalyzedPeriod", - "metricValueInReferencePeriod", - "overallMetricValueInAnalyzedPeriod", - "overallMetricValueInReferencePeriod" - ], - "type": "object" - }, - "NegativeAttributeFilter": { - "description": "Filter able to limit element values by label and related selected negated elements.", - "properties": { - "negativeAttributeFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "label": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "localIdentifier": { - "type": "string" - }, - "notIn": { - "$ref": "#/components/schemas/AttributeFilterElements" - } - }, - "required": [ - "notIn", - "label" - ], - "type": "object" - } - }, - "required": [ - "negativeAttributeFilter" - ], - "type": "object" - }, - "Operation": { - "description": "Represents a Long-Running Operation: a process that takes some time to complete.", - "discriminator": { - "mapping": { - "failed": "#/components/schemas/FailedOperation", - "pending": "#/components/schemas/PendingOperation", - "succeeded": "#/components/schemas/SucceededOperation" - }, - "propertyName": "status" - }, - "properties": { - "id": { - "description": "Id of the operation", - "type": "string" - }, - "kind": { - "description": "Type of the long-running operation. \n* `provision-database` — Provisioning of an AI Lake database. \n* `deprovision-database` — Deprovisioning (deletion) of an AI Lake database.\n", - "enum": [ - "provision-database", - "deprovision-database" - ], - "type": "string" - }, - "status": { - "type": "string" - } - }, - "required": [ - "id", - "kind", - "status" - ], - "type": "object" - }, - "OperationError": { - "description": "Error information for a failed operation", - "properties": { - "detail": { - "description": "Human-readable error details", - "type": "string" - }, - "status": { - "description": "HTTP status code", - "format": "int32", - "type": "integer" - }, - "title": { - "description": "Human-readable error name", - "type": "string" - } - }, - "required": [ - "detail", - "status", - "title" - ], - "type": "object" - }, - "OutlierDetectionRequest": { - "properties": { - "attributes": { - "description": "Attributes to be used in the computation.", - "items": { - "$ref": "#/components/schemas/AttributeItem" - }, - "type": "array" - }, - "auxMeasures": { - "description": "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "type": "array" - }, - "filters": { - "description": "Various filter types to filter the execution result.", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AbstractMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" - }, - { - "$ref": "#/components/schemas/InlineFilterDefinition" - } - ] - }, - "type": "array" - }, - "granularity": { - "description": "Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).", - "enum": [ - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR" - ], - "type": "string" - }, - "measures": { - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "minItems": 1, - "type": "array" - }, - "sensitivity": { - "description": "Sensitivity level for outlier detection", - "enum": [ - "LOW", - "MEDIUM", - "HIGH" - ], - "type": "string" - } - }, - "required": [ - "attributes", - "filters", - "granularity", - "measures", - "sensitivity" - ], - "type": "object" - }, - "OutlierDetectionResponse": { - "properties": { - "links": { - "$ref": "#/components/schemas/ExecutionLinks" - } - }, - "required": [ - "links" - ], - "type": "object" - }, - "OutlierDetectionResult": { - "properties": { - "attribute": { - "description": "Attribute values for outlier detection results.", - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "values": { - "additionalProperties": { - "description": "Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.", - "items": { - "description": "Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.", - "nullable": true, - "type": "number" - }, - "nullable": true, - "type": "array" - }, - "description": "Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.", - "nullable": true, - "type": "object" - } - }, - "required": [ - "attribute", - "values" - ], - "type": "object" - }, - "Paging": { - "description": "Current page description.", - "properties": { - "count": { - "description": "Count of items in this page.", - "example": 5, - "format": "int32", - "type": "integer" - }, - "next": { - "description": "Link to next page, or null if this is last page.", - "example": "https://sample.gooddata.com/api/v1/actions/workspaces/sampleWorkspace/execution/collectLabelElements?label=sample.price&limit=5&offset=10", - "type": "string" - }, - "offset": { - "description": "Offset of this page.", - "example": 10, - "format": "int32", - "type": "integer" - }, - "total": { - "description": "Count of returnable items ignoring paging.", - "example": 100, - "format": "int32", - "type": "integer" - } - }, - "required": [ - "count", - "offset", - "total" - ], - "type": "object" - }, - "PendingOperation": { - "allOf": [ - { - "$ref": "#/components/schemas/Operation" - } - ], - "description": "Operation that is still pending", - "required": [ - "id", - "kind" - ], - "type": "object" - }, - "PopDataset": { - "description": "Combination of the date data set to use and how many periods ago to calculate the previous period for.", - "properties": { - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" - }, - "periodsAgo": { - "description": "Number of periods ago to calculate the previous period for.", - "example": 1, - "format": "int32", - "type": "integer" - } - }, - "required": [ - "dataset", - "periodsAgo" - ], - "type": "object" - }, - "PopDatasetMeasureDefinition": { - "description": "Previous period type of metric.", - "properties": { - "previousPeriodMeasure": { - "properties": { - "dateDatasets": { - "description": "Specification of which date data sets to use for determining the period to calculate the previous period for.", - "items": { - "$ref": "#/components/schemas/PopDataset" - }, - "type": "array" - }, - "measureIdentifier": { - "$ref": "#/components/schemas/AfmLocalIdentifier" - } + "SearchRequest" : { + "properties" : { + "allowedRelationshipTypes" : { + "description" : "Filter relationships and results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned, and results are filtered to include only direct matches or objects reachable via allowed relationships. When null or omitted, all relationships and results are returned (default behavior). Note: This filtering happens after the initial search, so the number of returned results may be lower than the requested limit if some results are filtered out.", + "items" : { + "$ref" : "#/components/schemas/AllowedRelationshipType" }, - "required": [ - "dateDatasets", - "measureIdentifier" - ], - "type": "object" - } - }, - "required": [ - "previousPeriodMeasure" - ], - "type": "object" - }, - "PopDate": { - "description": "Combination of the date attribute to use and how many periods ago to calculate the PoP for.", - "properties": { - "attribute": { - "$ref": "#/components/schemas/AfmObjectIdentifierAttribute" - }, - "periodsAgo": { - "description": "Number of periods ago to calculate the previous period for.", - "example": 1, - "format": "int32", - "type": "integer" - } - }, - "required": [ - "attribute", - "periodsAgo" - ], - "type": "object" - }, - "PopDateMeasureDefinition": { - "description": "Period over period type of metric.", - "properties": { - "overPeriodMeasure": { - "properties": { - "dateAttributes": { - "description": "Attributes to use for determining the period to calculate the PoP for.", - "items": { - "$ref": "#/components/schemas/PopDate" - }, - "type": "array" - }, - "measureIdentifier": { - "$ref": "#/components/schemas/AfmLocalIdentifier" - } + "type" : "array" + }, + "deepSearch" : { + "default" : false, + "description" : "Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.", + "type" : "boolean" + }, + "excludeTags" : { + "description" : "Exclude objects that contain any of the specified tags. This parameter only affects the search results. Objects with excluded tags are completely hidden from the results.", + "items" : { + "description" : "Tag to exclude.", + "type" : "string" }, - "required": [ - "dateAttributes", - "measureIdentifier" - ], - "type": "object" + "type" : "array" + }, + "includeHidden" : { + "default" : false, + "description" : "If true, includes hidden objects in search results. If false (default), excludes objects where isHidden=true.", + "type" : "boolean" + }, + "includeTags" : { + "description" : "Include only objects that contain at least one of the specified tags (OR logic). This parameter only affects the search results. If an object has multiple tags, it will be included as long as it matches at least one tag from this parameter.", + "items" : { + "description" : "Tag to include.", + "type" : "string" + }, + "type" : "array" + }, + "limit" : { + "default" : 10, + "description" : "Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested. This can happen when post-search filters are applied (e.g., reranker threshold filtering or allowedRelationshipTypes filtering), which may exclude some results after the initial search.", + "format" : "int32", + "type" : "integer" + }, + "objectTypes" : { + "description" : "List of object types to search for.", + "items" : { + "description" : "Object type to search for.", + "enum" : [ "attribute", "metric", "fact", "label", "date", "dataset", "visualization", "dashboard" ], + "type" : "string" + }, + "type" : "array" + }, + "question" : { + "description" : "Keyword/sentence is input for search.", + "maxLength" : 1000, + "type" : "string" + }, + "relevantScoreThreshold" : { + "default" : 0.3, + "description" : "Score, above which we return found objects. Below this score objects are not relevant.", + "format" : "double", + "type" : "number" + }, + "titleToDescriptorRatio" : { + "default" : 0.7, + "description" : "Temporary for experiments. Ratio of title score to descriptor score.", + "format" : "double", + "type" : "number" } }, - "required": [ - "overPeriodMeasure" - ], - "type": "object" + "required" : [ "question" ], + "type" : "object" }, - "PopMeasureDefinition": { - "oneOf": [ - { - "$ref": "#/components/schemas/PopDatasetMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopDateMeasureDefinition" + "SearchResult" : { + "properties" : { + "reasoning" : { + "description" : "DEPRECATED: Use top-level reasoning.steps instead. If something is not working properly this field will contain explanation.", + "type" : "string" + }, + "relationships" : { + "items" : { + "$ref" : "#/components/schemas/SearchRelationshipObject" + }, + "type" : "array" + }, + "results" : { + "items" : { + "$ref" : "#/components/schemas/SearchResultObject" + }, + "type" : "array" + } + }, + "required" : [ "reasoning", "relationships", "results" ], + "type" : "object" + }, + "SearchResultObject" : { + "properties" : { + "createdAt" : { + "description" : "Timestamp when object was created.", + "format" : "date-time", + "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" + }, + "modifiedAt" : { + "description" : "Timestamp when object was last modified.", + "format" : "date-time", + "type" : "string" + }, + "score" : { + "description" : "Result score calculated by a similarity search algorithm (cosine_distance).", + "format" : "float", + "type" : "number" + }, + "scoreDescriptor" : { + "description" : "Result score for descriptor containing(now) description and tags.", + "format" : "float", + "type" : "number" + }, + "scoreExactMatch" : { + "description" : "Result score for exact match(id/title). 1/1000. Other scores are multiplied by this.", + "format" : "int32", + "type" : "integer" + }, + "scoreTitle" : { + "description" : "Result score for object title.", + "format" : "float", + "type" : "number" + }, + "tags" : { + "items" : { + "description" : "List of tags assigned to the object.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Object title.", + "type" : "string" + }, + "type" : { + "description" : "Object type, e.g. dashboard.", + "type" : "string" + }, + "visualizationUrl" : { + "description" : "If the object is visualization, this field defines the type of visualization.", + "type" : "string" + }, + "workspaceId" : { + "description" : "Workspace ID.", + "type" : "string" } - ], - "type": "object" + }, + "required" : [ "id", "title", "type", "workspaceId" ], + "type" : "object" }, - "PositiveAttributeFilter": { - "description": "Filter able to limit element values by label and related selected elements.", - "properties": { - "positiveAttributeFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "in": { - "$ref": "#/components/schemas/AttributeFilterElements" - }, - "label": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "localIdentifier": { - "type": "string" - } - }, - "required": [ - "in", - "label" - ], - "type": "object" - } - }, - "required": [ - "positiveAttributeFilter" - ], - "type": "object" - }, - "ProvisionDatabaseInstanceRequest": { - "description": "Request to provision a new AILake Database instance", - "properties": { - "name": { - "description": "Name of the database instance", - "type": "string" - }, - "storageIds": { - "description": "Set of ids of the storage instances this database instance should access.", - "items": { - "description": "Set of ids of the storage instances this database instance should access.", - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "name", - "storageIds" - ], - "type": "object" - }, - "QualityIssue": { - "description": "List of quality issues (available when status is COMPLETED)", - "properties": { - "code": { - "description": "Quality issue code", - "example": "SIMILAR_NAMES", - "type": "string" - }, - "detail": { - "additionalProperties": { - "description": "Detailed information about the quality issue", - "type": "object" - }, - "description": "Detailed information about the quality issue", - "type": "object" - }, - "id": { - "description": "Unique identifier for the quality issue", - "type": "string" - }, - "objects": { - "description": "List of objects affected by this quality issue", - "items": { - "$ref": "#/components/schemas/QualityIssueObject" - }, - "type": "array" - }, - "severity": { - "description": "Severity level", - "enum": [ - "WARNING", - "INFO" - ], - "type": "string" - } - }, - "required": [ - "code", - "detail", - "id", - "objects", - "severity" - ], - "type": "object" - }, - "QualityIssueObject": { - "description": "List of objects affected by this quality issue", - "properties": { - "id": { - "description": "Object ID", - "example": "revenue", - "type": "string" - }, - "title": { - "description": "Object title", - "example": "Total Revenue", - "type": "string" - }, - "type": { - "description": "Object type", - "example": "metric", - "type": "string" - }, - "workspaceId": { - "description": "Workspace ID where the object belongs", - "example": "demo", - "type": "string" - } - }, - "required": [ - "id", - "title", - "type", - "workspaceId" - ], - "type": "object" - }, - "QualityIssuesCalculationStatusResponse": { - "properties": { - "error": { - "description": "Error message (available when status is FAILED or NOT_FOUND)", - "type": "string" - }, - "issues": { - "description": "List of quality issues (available when status is COMPLETED)", - "items": { - "$ref": "#/components/schemas/QualityIssue" - }, - "type": "array" - }, - "status": { - "description": "Current status of the calculation", - "enum": [ - "RUNNING", - "SYNCING", - "COMPLETED", - "FAILED", - "NOT_FOUND", - "DISABLED" - ], - "type": "string" - } - }, - "required": [ - "status" - ], - "type": "object" - }, - "RangeCondition": { - "description": "Condition that checks if the metric value is within a given range.", - "properties": { - "range": { - "properties": { - "from": { - "example": 100, - "type": "number" - }, - "operator": { - "enum": [ - "BETWEEN", - "NOT_BETWEEN" - ], - "example": "BETWEEN", - "type": "string" + "ServerSentEventChatResult" : { + "type" : "object" + }, + "SimpleMeasureDefinition" : { + "description" : "Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.", + "properties" : { + "measure" : { + "properties" : { + "aggregation" : { + "description" : "Definition of aggregation type of the metric.", + "enum" : [ "SUM", "COUNT", "AVG", "MIN", "MAX", "MEDIAN", "RUNSUM", "APPROXIMATE_COUNT" ], + "example" : "SUM", + "type" : "string" }, - "to": { - "example": 999, - "type": "number" - } - }, - "required": [ - "from", - "operator", - "to" - ], - "type": "object" - } - }, - "required": [ - "range" - ], - "type": "object" - }, - "RangeMeasureValueFilter": { - "description": "Filter the result by comparing specified metric to given range of values.", - "properties": { - "rangeMeasureValueFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" + "computeRatio" : { + "default" : false, + "description" : "If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).", + "example" : true, + "type" : "boolean" }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" + "filters" : { + "description" : "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.", + "items" : { + "$ref" : "#/components/schemas/FilterDefinitionForSimpleMeasure" }, - "type": "array" - }, - "from": { - "example": 100, - "type": "number" - }, - "localIdentifier": { - "type": "string" - }, - "measure": { - "$ref": "#/components/schemas/AfmIdentifier" + "type" : "array" }, - "operator": { - "enum": [ - "BETWEEN", - "NOT_BETWEEN" - ], - "example": "BETWEEN", - "type": "string" - }, - "to": { - "example": 999, - "type": "number" - }, - "treatNullValuesAs": { - "description": "A value that will be substituted for null values in the metric for the comparisons.", - "example": 0, - "type": "number" + "item" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierCore" } }, - "required": [ - "from", - "operator", - "to", - "measure" - ], - "type": "object" - } - }, - "required": [ - "rangeMeasureValueFilter" - ], - "type": "object" - }, - "RankingFilter": { - "description": "Filter the result on top/bottom N values according to given metric(s).", - "properties": { - "rankingFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "type": "array" + "required" : [ "item" ], + "type" : "object" + } + }, + "required" : [ "measure" ], + "type" : "object" + }, + "SmartFunctionResponse" : { + "properties" : { + "links" : { + "$ref" : "#/components/schemas/ExecutionLinks" + } + }, + "required" : [ "links" ], + "type" : "object" + }, + "SortKey" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/SortKeyAttribute" + }, { + "$ref" : "#/components/schemas/SortKeyValue" + }, { + "$ref" : "#/components/schemas/SortKeyTotal" + } ], + "type" : "object" + }, + "SortKeyAttribute" : { + "description" : "Sorting rule for sorting by attribute value in current dimension.", + "properties" : { + "attribute" : { + "properties" : { + "attributeIdentifier" : { + "description" : "Item reference (to 'itemIdentifiers') referencing, which item should be used for sorting. Only references to attributes are allowed.", + "example" : "attribute1", + "type" : "string" }, - "localIdentifier": { - "type": "string" + "direction" : { + "description" : "Sorting elements - ascending/descending order.", + "enum" : [ "ASC", "DESC" ], + "type" : "string" }, - "measures": { - "description": "References to the metrics to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "type": "array" - }, - "operator": { - "description": "The type of ranking to use, TOP or BOTTOM.", - "enum": [ - "TOP", - "BOTTOM" - ], - "type": "string" - }, - "value": { - "description": "Number of top/bottom values to filter.", - "example": 5, - "format": "int32", - "type": "integer" + "sortType" : { + "default" : "DEFAULT", + "description" : "Mechanism by which this attribute should be sorted. Available options are:\n- DEFAULT: sorting based on default rules (using sort column if defined, otherwise this label) \n- LABEL: sorting by this label values \n- ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label) \n- ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label)- AREA: sorting by area (total or subtotal) corresponding to each attribute value. The area is computed by summing up all metric values in all other dimensions.", + "enum" : [ "DEFAULT", "LABEL", "ATTRIBUTE", "AREA" ], + "type" : "string" } }, - "required": [ - "measures", - "operator", - "value" - ], - "type": "object" - } - }, - "required": [ - "rankingFilter" - ], - "type": "object" - }, - "Reasoning": { - "description": "Reasoning wrapper containing steps taken during request handling.", - "properties": { - "answer": { - "description": "Final answer/reasoning from the use case result.", - "type": "string" - }, - "steps": { - "description": "Steps taken during processing, showing the AI's reasoning process.", - "items": { - "$ref": "#/components/schemas/ReasoningStep" - }, - "type": "array" - } - }, - "required": [ - "steps" - ], - "type": "object" - }, - "ReasoningStep": { - "description": "Steps taken during processing, showing the AI's reasoning process.", - "properties": { - "thoughts": { - "description": "Detailed thoughts/messages within this step.", - "items": { - "$ref": "#/components/schemas/Thought" - }, - "type": "array" - }, - "title": { - "description": "Title describing this reasoning step.", - "type": "string" - } - }, - "required": [ - "thoughts", - "title" - ], - "type": "object" - }, - "RelativeDateFilter": { - "description": "A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both.", - "properties": { - "relativeDateFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "boundedFilter": { - "$ref": "#/components/schemas/BoundedFilter" - }, - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" - }, - "from": { - "description": "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago').", - "example": -6, - "format": "int32", - "type": "integer" - }, - "granularity": { - "description": "Date granularity specifying particular date attribute in given dimension.", - "enum": [ - "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", - "MINUTE_OF_HOUR", - "HOUR_OF_DAY", - "DAY_OF_WEEK", - "DAY_OF_MONTH", - "DAY_OF_QUARTER", - "DAY_OF_YEAR", - "WEEK_OF_YEAR", - "MONTH_OF_YEAR", - "QUARTER_OF_YEAR", - "FISCAL_MONTH", - "FISCAL_QUARTER", - "FISCAL_YEAR" - ], - "example": "DAY", - "type": "string" - }, - "includeEmptyValues": { - "description": "If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).", - "type": "boolean" + "required" : [ "attributeIdentifier" ], + "type" : "object" + } + }, + "required" : [ "attribute" ], + "type" : "object" + }, + "SortKeyTotal" : { + "description" : "Sorting rule for sorting by total value. DataColumnLocators are only required if there is ambiguity. Locator for measureGroup is taken from the metric of the total.", + "properties" : { + "total" : { + "properties" : { + "dataColumnLocators" : { + "$ref" : "#/components/schemas/DataColumnLocators" }, - "localIdentifier": { - "type": "string" + "direction" : { + "description" : "Sorting elements - ascending/descending order.", + "enum" : [ "ASC", "DESC" ], + "type" : "string" }, - "to": { - "description": "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...).", - "example": 0, - "format": "int32", - "type": "integer" + "totalIdentifier" : { + "description" : "Local identifier of the total to sort by.", + "type" : "string" } }, - "required": [ - "from", - "granularity", - "to", - "dataset" - ], - "type": "object" - } - }, - "required": [ - "relativeDateFilter" - ], - "type": "object" - }, - "ResolvedLlmEndpoint": { - "properties": { - "id": { - "description": "Endpoint Id", - "type": "string" - }, - "title": { - "description": "Endpoint Title", - "type": "string" - } - }, - "required": [ - "id", - "title" - ], - "type": "object" - }, - "ResolvedLlmEndpoints": { - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/ResolvedLlmEndpoint" - }, - "type": "array" + "required" : [ "totalIdentifier" ], + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "total" ], + "type" : "object" }, - "RestApiIdentifier": { - "description": "Object identifier.", - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "example": "fact", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "ResultCacheMetadata": { - "description": "All execution result's metadata used for calculation including ExecutionResponse", - "properties": { - "afm": { - "$ref": "#/components/schemas/AFM" - }, - "executionResponse": { - "$ref": "#/components/schemas/ExecutionResponse" - }, - "resultSize": { - "format": "int64", - "type": "integer" - }, - "resultSpec": { - "$ref": "#/components/schemas/ResultSpec" - } - }, - "required": [ - "afm", - "executionResponse", - "resultSize", - "resultSpec" - ], - "type": "object" - }, - "ResultDimension": { - "description": "Single result dimension", - "properties": { - "headers": { - "items": { - "$ref": "#/components/schemas/ResultDimensionHeader" - }, - "type": "array" - }, - "localIdentifier": { - "description": "Local identifier of the dimension.", - "type": "string" - } - }, - "required": [ - "headers", - "localIdentifier" - ], - "type": "object" - }, - "ResultDimensionHeader": { - "description": "One of the headers in a result dimension.", - "oneOf": [ - { - "$ref": "#/components/schemas/MeasureGroupHeaders" - }, - { - "$ref": "#/components/schemas/AttributeHeader" - } - ], - "type": "object" - }, - "ResultSpec": { - "description": "Specifies how the result data will be formatted (```dimensions```) and which additional data shall be computed (```totals```).", - "properties": { - "dimensions": { - "items": { - "$ref": "#/components/schemas/Dimension" - }, - "type": "array" - }, - "totals": { - "items": { - "$ref": "#/components/schemas/Total" - }, - "type": "array" - } - }, - "required": [ - "dimensions" - ], - "type": "object" - }, - "RouteResult": { - "description": "Question -> Use Case routing. May contain final answer is a special use case is not required.", - "properties": { - "reasoning": { - "description": "Explanation why LLM picked this use case.", - "type": "string" - }, - "useCase": { - "description": "Use case where LLM routed based on question.", - "enum": [ - "INVALID", - "GENERAL", - "SEARCH", - "CREATE_VISUALIZATION", - "EXTEND_VISUALIZATION", - "HOWTO", - "CHANGE_ANALYSIS", - "ALERT" - ], - "type": "string" - } - }, - "required": [ - "reasoning", - "useCase" - ], - "type": "object" - }, - "SavedVisualization": { - "description": "Created and saved visualization IDs.", - "properties": { - "createdVisualizationId": { - "description": "Created visualization ID.", - "type": "string" - }, - "savedVisualizationId": { - "description": "Saved visualization ID.", - "type": "string" - } - }, - "required": [ - "createdVisualizationId", - "savedVisualizationId" - ], - "type": "object" - }, - "SearchRelationshipObject": { - "properties": { - "sourceObjectId": { - "description": "Source object ID.", - "type": "string" - }, - "sourceObjectTitle": { - "description": "Source object title.", - "type": "string" - }, - "sourceObjectType": { - "description": "Source object type, e.g. dashboard.", - "type": "string" - }, - "sourceWorkspaceId": { - "description": "Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located.", - "type": "string" - }, - "targetObjectId": { - "description": "Target object ID.", - "type": "string" - }, - "targetObjectTitle": { - "description": "Target object title.", - "type": "string" - }, - "targetObjectType": { - "description": "Target object type, e.g. visualization.", - "type": "string" - }, - "targetWorkspaceId": { - "description": "Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located.", - "type": "string" - } - }, - "required": [ - "sourceObjectId", - "sourceObjectTitle", - "sourceObjectType", - "sourceWorkspaceId", - "targetObjectId", - "targetObjectTitle", - "targetObjectType", - "targetWorkspaceId" - ], - "type": "object" - }, - "SearchRequest": { - "properties": { - "allowedRelationshipTypes": { - "description": "Filter relationships and results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned, and results are filtered to include only direct matches or objects reachable via allowed relationships. When null or omitted, all relationships and results are returned (default behavior). Note: This filtering happens after the initial search, so the number of returned results may be lower than the requested limit if some results are filtered out.", - "items": { - "$ref": "#/components/schemas/AllowedRelationshipType" - }, - "type": "array" - }, - "deepSearch": { - "default": false, - "description": "Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.", - "type": "boolean" - }, - "excludeTags": { - "description": "Exclude objects that contain any of the specified tags. This parameter only affects the search results. Objects with excluded tags are completely hidden from the results.", - "items": { - "description": "Tag to exclude.", - "type": "string" - }, - "type": "array" - }, - "includeHidden": { - "default": false, - "description": "If true, includes hidden objects in search results. If false (default), excludes objects where isHidden=true.", - "type": "boolean" - }, - "includeTags": { - "description": "Include only objects that contain at least one of the specified tags (OR logic). This parameter only affects the search results. If an object has multiple tags, it will be included as long as it matches at least one tag from this parameter.", - "items": { - "description": "Tag to include.", - "type": "string" - }, - "type": "array" - }, - "limit": { - "default": 10, - "description": "Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested. This can happen when post-search filters are applied (e.g., reranker threshold filtering or allowedRelationshipTypes filtering), which may exclude some results after the initial search.", - "format": "int32", - "type": "integer" - }, - "objectTypes": { - "description": "List of object types to search for.", - "items": { - "description": "Object type to search for.", - "enum": [ - "attribute", - "metric", - "fact", - "label", - "date", - "dataset", - "visualization", - "dashboard" - ], - "type": "string" - }, - "type": "array" - }, - "question": { - "description": "Keyword/sentence is input for search.", - "maxLength": 1000, - "type": "string" - }, - "relevantScoreThreshold": { - "default": 0.3, - "description": "Score, above which we return found objects. Below this score objects are not relevant.", - "format": "double", - "type": "number" - }, - "titleToDescriptorRatio": { - "default": 0.7, - "description": "Temporary for experiments. Ratio of title score to descriptor score.", - "format": "double", - "type": "number" - } - }, - "required": [ - "question" - ], - "type": "object" - }, - "SearchResult": { - "properties": { - "reasoning": { - "description": "DEPRECATED: Use top-level reasoning.steps instead. If something is not working properly this field will contain explanation.", - "type": "string" - }, - "relationships": { - "items": { - "$ref": "#/components/schemas/SearchRelationshipObject" - }, - "type": "array" - }, - "results": { - "items": { - "$ref": "#/components/schemas/SearchResultObject" - }, - "type": "array" - } - }, - "required": [ - "reasoning", - "relationships", - "results" - ], - "type": "object" - }, - "SearchResultObject": { - "properties": { - "createdAt": { - "description": "Timestamp when object was created.", - "format": "date-time", - "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" - }, - "modifiedAt": { - "description": "Timestamp when object was last modified.", - "format": "date-time", - "type": "string" - }, - "score": { - "description": "Result score calculated by a similarity search algorithm (cosine_distance).", - "format": "float", - "type": "number" - }, - "scoreDescriptor": { - "description": "Result score for descriptor containing(now) description and tags.", - "format": "float", - "type": "number" - }, - "scoreExactMatch": { - "description": "Result score for exact match(id/title). 1/1000. Other scores are multiplied by this.", - "format": "int32", - "type": "integer" - }, - "scoreTitle": { - "description": "Result score for object title.", - "format": "float", - "type": "number" - }, - "tags": { - "items": { - "description": "List of tags assigned to the object.", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Object title.", - "type": "string" - }, - "type": { - "description": "Object type, e.g. dashboard.", - "type": "string" - }, - "visualizationUrl": { - "description": "If the object is visualization, this field defines the type of visualization.", - "type": "string" - }, - "workspaceId": { - "description": "Workspace ID.", - "type": "string" - } - }, - "required": [ - "id", - "title", - "type", - "workspaceId" - ], - "type": "object" - }, - "ServerSentEventChatResult": { - "type": "object" - }, - "SimpleMeasureDefinition": { - "description": "Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.", - "properties": { - "measure": { - "properties": { - "aggregation": { - "description": "Definition of aggregation type of the metric.", - "enum": [ - "SUM", - "COUNT", - "AVG", - "MIN", - "MAX", - "MEDIAN", - "RUNSUM", - "APPROXIMATE_COUNT" - ], - "example": "SUM", - "type": "string" - }, - "computeRatio": { - "default": false, - "description": "If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).", - "example": true, - "type": "boolean" - }, - "filters": { - "description": "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.", - "items": { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" - }, - "type": "array" + "SortKeyValue" : { + "description" : "Sorting rule for sorting by measure value. DataColumnLocators for each dimension opposite to the sorted one must be specified.", + "properties" : { + "value" : { + "properties" : { + "dataColumnLocators" : { + "$ref" : "#/components/schemas/DataColumnLocators" }, - "item": { - "$ref": "#/components/schemas/AfmObjectIdentifierCore" + "direction" : { + "description" : "Sorting elements - ascending/descending order.", + "enum" : [ "ASC", "DESC" ], + "type" : "string" } }, - "required": [ - "item" - ], - "type": "object" + "required" : [ "dataColumnLocators" ], + "type" : "object" } }, - "required": [ - "measure" - ], - "type": "object" + "required" : [ "value" ], + "type" : "object" }, - "SmartFunctionResponse": { - "properties": { - "links": { - "$ref": "#/components/schemas/ExecutionLinks" + "SucceededOperation" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Operation" + }, { + "properties" : { + "result" : { + "description" : "Operation-specific result payload, can be missing for operations like delete", + "type" : "object" + } + }, + "type" : "object" + } ], + "description" : "Operation that has succeeded", + "required" : [ "id", "kind" ], + "type" : "object" + }, + "Suggestion" : { + "description" : "List of suggestions for next steps. Filled when no visualization was created, suggests alternatives.", + "properties" : { + "label" : { + "description" : "Suggestion button label", + "type" : "string" + }, + "query" : { + "description" : "Suggestion query", + "type" : "string" } }, - "required": [ - "links" - ], - "type": "object" + "required" : [ "label", "query" ], + "type" : "object" }, - "SortKey": { - "oneOf": [ - { - "$ref": "#/components/schemas/SortKeyAttribute" + "Thought" : { + "description" : "Detailed thoughts/messages within this step.", + "properties" : { + "text" : { + "description" : "The text content of this thought.", + "type" : "string" + } + }, + "required" : [ "text" ], + "type" : "object" + }, + "Total" : { + "description" : "Definition of a total. There are two types of totals: grand totals and subtotals. Grand total data will be returned in a separate section of the result structure while subtotals are fully integrated into the main result data. The mechanism for this distinction is automatic and it's described in `TotalDimension`", + "properties" : { + "function" : { + "description" : "Aggregation function to compute the total.", + "enum" : [ "SUM", "MIN", "MAX", "AVG", "MED", "NAT" ], + "example" : "SUM", + "type" : "string" + }, + "localIdentifier" : { + "description" : "Total identification within this request. Used e.g. in sorting by a total.", + "example" : "firstTotal", + "type" : "string" }, - { - "$ref": "#/components/schemas/SortKeyValue" + "metric" : { + "description" : "The metric for which the total will be computed", + "example" : "metric_1", + "type" : "string" }, - { - "$ref": "#/components/schemas/SortKeyTotal" + "totalDimensions" : { + "items" : { + "$ref" : "#/components/schemas/TotalDimension" + }, + "type" : "array" } - ], - "type": "object" + }, + "required" : [ "function", "localIdentifier", "metric", "totalDimensions" ], + "type" : "object" }, - "SortKeyAttribute": { - "description": "Sorting rule for sorting by attribute value in current dimension.", - "properties": { - "attribute": { - "properties": { - "attributeIdentifier": { - "description": "Item reference (to 'itemIdentifiers') referencing, which item should be used for sorting. Only references to attributes are allowed.", - "example": "attribute1", - "type": "string" - }, - "direction": { - "description": "Sorting elements - ascending/descending order.", - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - }, - "sortType": { - "default": "DEFAULT", - "description": "Mechanism by which this attribute should be sorted. Available options are:\n- DEFAULT: sorting based on default rules (using sort column if defined, otherwise this label) \n- LABEL: sorting by this label values \n- ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label) \n- ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label)- AREA: sorting by area (total or subtotal) corresponding to each attribute value. The area is computed by summing up all metric values in all other dimensions.", - "enum": [ - "DEFAULT", - "LABEL", - "ATTRIBUTE", - "AREA" - ], - "type": "string" - } + "TotalDimension" : { + "description" : "A list of dimensions across which the total will be computed. Total headers for only these dimensions will be returned in the result.", + "properties" : { + "dimensionIdentifier" : { + "description" : "An identifier of a dimension for which the total will be computed.", + "example" : "firstDimension", + "pattern" : "^[.a-zA-Z0-9_-]+$", + "type" : "string" + }, + "totalDimensionItems" : { + "description" : "List of dimension items which will be used for total computation. The total is a grand total in this dimension if the list is empty or it includes the first dimension item from the dimension definition, and its data and header will be returned in a separate `ExecutionResultGrandTotal` structure. Otherwise, it is a subtotal and the data will be integrated into the main result.", + "example" : [ "measureGroup" ], + "items" : { + "type" : "string" }, - "required": [ - "attributeIdentifier" - ], - "type": "object" + "type" : "array" } }, - "required": [ - "attribute" - ], - "type": "object" + "required" : [ "dimensionIdentifier", "totalDimensionItems" ], + "type" : "object" }, - "SortKeyTotal": { - "description": "Sorting rule for sorting by total value. DataColumnLocators are only required if there is ambiguity. Locator for measureGroup is taken from the metric of the total.", - "properties": { - "total": { - "properties": { - "dataColumnLocators": { - "$ref": "#/components/schemas/DataColumnLocators" - }, - "direction": { - "description": "Sorting elements - ascending/descending order.", - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - }, - "totalIdentifier": { - "description": "Local identifier of the total to sort by.", - "type": "string" - } - }, - "required": [ - "totalIdentifier" - ], - "type": "object" + "TotalExecutionResultHeader" : { + "properties" : { + "totalHeader" : { + "$ref" : "#/components/schemas/TotalResultHeader" } }, - "required": [ - "total" - ], - "type": "object" + "required" : [ "totalHeader" ], + "type" : "object" }, - "SortKeyValue": { - "description": "Sorting rule for sorting by measure value. DataColumnLocators for each dimension opposite to the sorted one must be specified.", - "properties": { - "value": { - "properties": { - "dataColumnLocators": { - "$ref": "#/components/schemas/DataColumnLocators" - }, - "direction": { - "description": "Sorting elements - ascending/descending order.", - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - } - }, - "required": [ - "dataColumnLocators" - ], - "type": "object" + "TotalResultHeader" : { + "description" : "Header containing the information related to a subtotal.", + "properties" : { + "function" : { + "type" : "string" } }, - "required": [ - "value" - ], - "type": "object" + "required" : [ "function" ], + "type" : "object" }, - "SucceededOperation": { - "allOf": [ - { - "$ref": "#/components/schemas/Operation" + "TriggerQualityIssuesCalculationResponse" : { + "properties" : { + "processId" : { + "description" : "Process ID for tracking the calculation status", + "type" : "string" }, - { - "properties": { - "result": { - "description": "Operation-specific result payload, can be missing for operations like delete", - "type": "object" - } - }, - "type": "object" - } - ], - "description": "Operation that has succeeded", - "required": [ - "id", - "kind" - ], - "type": "object" - }, - "Suggestion": { - "description": "List of suggestions for next steps. Filled when no visualization was created, suggests alternatives.", - "properties": { - "label": { - "description": "Suggestion button label", - "type": "string" - }, - "query": { - "description": "Suggestion query", - "type": "string" - } - }, - "required": [ - "label", - "query" - ], - "type": "object" - }, - "Thought": { - "description": "Detailed thoughts/messages within this step.", - "properties": { - "text": { - "description": "The text content of this thought.", - "type": "string" - } - }, - "required": [ - "text" - ], - "type": "object" - }, - "Total": { - "description": "Definition of a total. There are two types of totals: grand totals and subtotals. Grand total data will be returned in a separate section of the result structure while subtotals are fully integrated into the main result data. The mechanism for this distinction is automatic and it's described in `TotalDimension`", - "properties": { - "function": { - "description": "Aggregation function to compute the total.", - "enum": [ - "SUM", - "MIN", - "MAX", - "AVG", - "MED", - "NAT" - ], - "example": "SUM", - "type": "string" - }, - "localIdentifier": { - "description": "Total identification within this request. Used e.g. in sorting by a total.", - "example": "firstTotal", - "type": "string" - }, - "metric": { - "description": "The metric for which the total will be computed", - "example": "metric_1", - "type": "string" - }, - "totalDimensions": { - "items": { - "$ref": "#/components/schemas/TotalDimension" - }, - "type": "array" - } - }, - "required": [ - "function", - "localIdentifier", - "metric", - "totalDimensions" - ], - "type": "object" - }, - "TotalDimension": { - "description": "A list of dimensions across which the total will be computed. Total headers for only these dimensions will be returned in the result.", - "properties": { - "dimensionIdentifier": { - "description": "An identifier of a dimension for which the total will be computed.", - "example": "firstDimension", - "pattern": "^[.a-zA-Z0-9_-]+$", - "type": "string" - }, - "totalDimensionItems": { - "description": "List of dimension items which will be used for total computation. The total is a grand total in this dimension if the list is empty or it includes the first dimension item from the dimension definition, and its data and header will be returned in a separate `ExecutionResultGrandTotal` structure. Otherwise, it is a subtotal and the data will be integrated into the main result.", - "example": [ - "measureGroup" - ], - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "dimensionIdentifier", - "totalDimensionItems" - ], - "type": "object" - }, - "TotalExecutionResultHeader": { - "properties": { - "totalHeader": { - "$ref": "#/components/schemas/TotalResultHeader" - } - }, - "required": [ - "totalHeader" - ], - "type": "object" - }, - "TotalResultHeader": { - "description": "Header containing the information related to a subtotal.", - "properties": { - "function": { - "type": "string" - } - }, - "required": [ - "function" - ], - "type": "object" - }, - "TriggerQualityIssuesCalculationResponse": { - "properties": { - "processId": { - "description": "Process ID for tracking the calculation status", - "type": "string" - }, - "status": { - "description": "Current status of the calculation", - "enum": [ - "RUNNING", - "COMPLETED", - "FAILED", - "DISABLED" - ], - "type": "string" - } - }, - "required": [ - "processId", - "status" - ], - "type": "object" - }, - "Unit": { - "type": "object" - }, - "UserContext": { - "description": "User context, which can affect the behavior of the underlying AI features.", - "properties": { - "activeObject": { - "$ref": "#/components/schemas/ActiveObjectIdentification" - } - }, - "required": [ - "activeObject" - ], - "type": "object" - }, - "ValidateByItem": { - "nullable": true, - "properties": { - "id": { - "description": "Specifies entity used for valid elements computation.", - "type": "string" - }, - "type": { - "description": "Specifies entity type which could be label, attribute, fact, or metric.", - "pattern": "^(label)|(attribute)|(fact)|(metric)$", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "ValidateLLMEndpointByIdRequest": { - "properties": { - "baseUrl": { - "description": "Base URL for the LLM endpoint validation", - "type": "string" - }, - "llmModel": { - "description": "LLM model for the LLM endpoint validation", - "type": "string" - }, - "llmOrganization": { - "description": "Organization name for the LLM endpoint validation", - "type": "string" - }, - "provider": { - "description": "Provider for the LLM endpoint validation", - "type": "string" - }, - "token": { - "description": "Token for the LLM endpoint validation", - "type": "string" - } - }, - "type": "object" - }, - "ValidateLLMEndpointRequest": { - "properties": { - "baseUrl": { - "description": "Base URL for the LLM endpoint validation", - "type": "string" - }, - "llmModel": { - "description": "LLM model for the LLM endpoint validation", - "type": "string" - }, - "llmOrganization": { - "description": "Organization name for the LLM endpoint validation", - "type": "string" - }, - "provider": { - "description": "Provider for the LLM endpoint validation", - "type": "string" - }, - "token": { - "description": "Token for the LLM endpoint validation", - "type": "string" - } - }, - "required": [ - "provider", - "token" - ], - "type": "object" - }, - "ValidateLLMEndpointResponse": { - "properties": { - "message": { - "description": "Additional message about the LLM endpoint validation", - "type": "string" + "status" : { + "description" : "Current status of the calculation", + "enum" : [ "RUNNING", "COMPLETED", "FAILED", "DISABLED" ], + "type" : "string" + } + }, + "required" : [ "processId", "status" ], + "type" : "object" + }, + "Unit" : { + "type" : "object" + }, + "UserContext" : { + "description" : "User context, which can affect the behavior of the underlying AI features.", + "properties" : { + "activeObject" : { + "$ref" : "#/components/schemas/ActiveObjectIdentification" + } + }, + "required" : [ "activeObject" ], + "type" : "object" + }, + "ValidateByItem" : { + "nullable" : true, + "properties" : { + "id" : { + "description" : "Specifies entity used for valid elements computation.", + "type" : "string" + }, + "type" : { + "description" : "Specifies entity type which could be label, attribute, fact, or metric.", + "pattern" : "^(label)|(attribute)|(fact)|(metric)$", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "ValidateLLMEndpointByIdRequest" : { + "properties" : { + "baseUrl" : { + "description" : "Base URL for the LLM endpoint validation", + "type" : "string" + }, + "llmModel" : { + "description" : "LLM model for the LLM endpoint validation", + "type" : "string" + }, + "llmOrganization" : { + "description" : "Organization name for the LLM endpoint validation", + "type" : "string" + }, + "provider" : { + "description" : "Provider for the LLM endpoint validation", + "type" : "string" + }, + "token" : { + "description" : "Token for the LLM endpoint validation", + "type" : "string" + } + }, + "type" : "object" + }, + "ValidateLLMEndpointRequest" : { + "properties" : { + "baseUrl" : { + "description" : "Base URL for the LLM endpoint validation", + "type" : "string" + }, + "llmModel" : { + "description" : "LLM model for the LLM endpoint validation", + "type" : "string" + }, + "llmOrganization" : { + "description" : "Organization name for the LLM endpoint validation", + "type" : "string" + }, + "provider" : { + "description" : "Provider for the LLM endpoint validation", + "type" : "string" + }, + "token" : { + "description" : "Token for the LLM endpoint validation", + "type" : "string" + } + }, + "required" : [ "provider", "token" ], + "type" : "object" + }, + "ValidateLLMEndpointResponse" : { + "properties" : { + "message" : { + "description" : "Additional message about the LLM endpoint validation", + "type" : "string" }, - "successful": { - "description": "Whether the LLM endpoint validation was successful", - "type": "boolean" + "successful" : { + "description" : "Whether the LLM endpoint validation was successful", + "type" : "boolean" } }, - "required": [ - "message", - "successful" - ], - "type": "object" + "required" : [ "message", "successful" ], + "type" : "object" } } }, - "info": { - "title": "OpenAPI definition", - "version": "v0" + "info" : { + "title" : "OpenAPI definition", + "version" : "v0" }, - "openapi": "3.0.1", - "paths": { - "/api/v1/actions/ai/llmEndpoint/test": { - "post": { - "description": "Validates LLM endpoint with provided parameters.", - "operationId": "validateLLMEndpoint", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidateLLMEndpointRequest" + "openapi" : "3.0.1", + "paths" : { + "/api/v1/actions/ai/llmEndpoint/test" : { + "post" : { + "description" : "Validates LLM endpoint with provided parameters.", + "operationId" : "validateLLMEndpoint", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ValidateLLMEndpointRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidateLLMEndpointResponse" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ValidateLLMEndpointResponse" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "Validate LLM Endpoint", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "Validate LLM Endpoint", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test": { - "post": { - "description": "Validates existing LLM endpoint with provided parameters and updates it if they are valid.", - "operationId": "validateLLMEndpointById", - "parameters": [ - { - "in": "path", - "name": "llmEndpointId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidateLLMEndpointByIdRequest" + "/api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test" : { + "post" : { + "description" : "Validates existing LLM endpoint with provided parameters and updates it if they are valid.", + "operationId" : "validateLLMEndpointById", + "parameters" : [ { + "in" : "path", + "name" : "llmEndpointId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ValidateLLMEndpointByIdRequest" } } } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidateLLMEndpointResponse" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ValidateLLMEndpointResponse" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "Validate LLM Endpoint By Id", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "Validate LLM Endpoint By Id", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy": { - "get": { - "description": "Returns a list of Users who created any object for this workspace", - "operationId": "createdBy", - "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/AnalyticsCatalogCreatedBy" + "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy" : { + "get" : { + "description" : "Returns a list of Users who created any object for this workspace", + "operationId" : "createdBy", + "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/AnalyticsCatalogCreatedBy" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "Get Analytics Catalog CreatedBy Users", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "Get Analytics Catalog CreatedBy Users", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags": { - "get": { - "description": "Returns a list of tags for this workspace", - "operationId": "tags", - "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/AnalyticsCatalogTags" + "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags" : { + "get" : { + "description" : "Returns a list of tags for this workspace", + "operationId" : "tags", + "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/AnalyticsCatalogTags" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "Get Analytics Catalog Tags", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "Get Analytics Catalog Tags", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/chat": { - "post": { - "description": "(BETA) Combines multiple use cases such as search, create visualizations, ...", - "operationId": "aiChat", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatRequest" + "/api/v1/actions/workspaces/{workspaceId}/ai/chat" : { + "post" : { + "description" : "(BETA) Combines multiple use cases such as search, create visualizations, ...", + "operationId" : "aiChat", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ChatRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatResult" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ChatResult" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "(BETA) Chat with AI", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "(BETA) Chat with AI", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/chatHistory": { - "post": { - "description": "(BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history.", - "operationId": "aiChatHistory", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatHistoryRequest" + "/api/v1/actions/workspaces/{workspaceId}/ai/chatHistory" : { + "post" : { + "description" : "(BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history.", + "operationId" : "aiChatHistory", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ChatHistoryRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatHistoryResult" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ChatHistoryResult" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "(BETA) Get Chat History", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "(BETA) Get Chat History", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/chatStream": { - "post": { - "description": "(BETA) Combines multiple use cases such as search, create visualizations, ...", - "operationId": "aiChatStream", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatRequest" + "/api/v1/actions/workspaces/{workspaceId}/ai/chatStream" : { + "post" : { + "description" : "(BETA) Combines multiple use cases such as search, create visualizations, ...", + "operationId" : "aiChatStream", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ChatRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "text/event-stream": { - "schema": { - "items": { - "$ref": "#/components/schemas/ServerSentEventChatResult" + "responses" : { + "200" : { + "content" : { + "text/event-stream" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/ServerSentEventChatResult" }, - "type": "array" + "type" : "array" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "(BETA) Chat with AI", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "(BETA) Chat with AI", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/chatUsage": { - "get": { - "description": "Returns usage statistics of chat for a user in a workspace.", - "operationId": "aiChatUsage", - "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/ChatUsageResponse" + "/api/v1/actions/workspaces/{workspaceId}/ai/chatUsage" : { + "get" : { + "description" : "Returns usage statistics of chat for a user in a workspace.", + "operationId" : "aiChatUsage", + "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/ChatUsageResponse" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "Get Chat Usage", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "Get Chat Usage", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/issues": { - "get": { - "description": "Returns metadata quality issues detected by the platform linter.", - "operationId": "getQualityIssues", - "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/GetQualityIssuesResponse" + "/api/v1/actions/workspaces/{workspaceId}/ai/issues" : { + "get" : { + "description" : "Returns metadata quality issues detected by the platform linter.", + "operationId" : "getQualityIssues", + "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/GetQualityIssuesResponse" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "Get Quality Issues", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "Get Quality Issues", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId}": { - "get": { - "description": "Returns the status of a quality issues calculation process identified by process ID.", - "operationId": "getQualityIssuesCalculationStatus", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "in": "path", - "name": "processId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/QualityIssuesCalculationStatusResponse" + "/api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId}" : { + "get" : { + "description" : "Returns the status of a quality issues calculation process identified by process ID.", + "operationId" : "getQualityIssuesCalculationStatus", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, { + "in" : "path", + "name" : "processId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/QualityIssuesCalculationStatusResponse" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "Get Quality Issues Calculation Status", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "Get Quality Issues Calculation Status", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck": { - "post": { - "description": "Triggers asynchronous calculation of metadata quality issues and returns a process ID for status tracking.", - "operationId": "triggerQualityIssuesCalculation", - "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/TriggerQualityIssuesCalculationResponse" + "/api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck" : { + "post" : { + "description" : "Triggers asynchronous calculation of metadata quality issues and returns a process ID for status tracking.", + "operationId" : "triggerQualityIssuesCalculation", + "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/TriggerQualityIssuesCalculationResponse" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "Trigger Quality Issues Calculation", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "Trigger Quality Issues Calculation", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/memory/createdBy": { - "get": { - "description": "Returns a list of Users who created any memory item for this workspace", - "operationId": "memoryCreatedByUsers", - "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/MemoryItemCreatedByUsers" + "/api/v1/actions/workspaces/{workspaceId}/ai/memory/createdBy" : { + "get" : { + "description" : "Returns a list of Users who created any memory item for this workspace", + "operationId" : "memoryCreatedByUsers", + "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/MemoryItemCreatedByUsers" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "Get AI Memory CreatedBy Users", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "Get AI Memory CreatedBy Users", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints": { - "get": { - "description": "Returns a list of available LLM Endpoints", - "operationId": "resolveLlmEndpoints", - "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/ResolvedLlmEndpoints" + "/api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints" : { + "get" : { + "description" : "Returns a list of available LLM Endpoints", + "operationId" : "resolveLlmEndpoints", + "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/ResolvedLlmEndpoints" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "Get Active LLM Endpoints for this workspace", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "Get Active LLM Endpoints for this workspace", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/search": { - "post": { - "description": "(BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.", - "operationId": "aiSearch", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SearchRequest" + "/api/v1/actions/workspaces/{workspaceId}/ai/search" : { + "post" : { + "description" : "(BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.", + "operationId" : "aiSearch", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SearchResult" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchResult" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "(BETA) Semantic Search in Metadata", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "(BETA) Semantic Search in Metadata", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel": { - "post": { - "description": "Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is cancelled.", - "operationId": "cancelExecutions", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AfmCancelTokens" + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel" : { + "post" : { + "description" : "Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is cancelled.", + "operationId" : "cancelExecutions", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AfmCancelTokens" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AfmCancelTokens" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AfmCancelTokens" } } }, - "description": "Status of the cancellation operation." + "description" : "Status of the cancellation operation." } }, - "summary": "Applies all the given cancel tokens.", - "tags": [ - "Computation", - "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to view a report or label elements.", - "permissions": [ - "VIEW" - ] + "summary" : "Applies all the given cancel tokens.", + "tags" : [ "Computation", "actions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to view a report or label elements.", + "permissions" : [ "VIEW" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants": { - "post": { - "description": "(BETA) Returns map of lists of attributes that can be used as descendants of the given attributes.", - "operationId": "computeValidDescendants", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AfmValidDescendantsQuery" + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants" : { + "post" : { + "description" : "(BETA) Returns map of lists of attributes that can be used as descendants of the given attributes.", + "operationId" : "computeValidDescendants", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AfmValidDescendantsQuery" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AfmValidDescendantsResponse" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AfmValidDescendantsResponse" } } }, - "description": "Map of lists of attributes valid as descendants of the given attributes." + "description" : "Map of lists of attributes valid as descendants of the given attributes." } }, - "summary": "(BETA) Valid descendants", - "tags": [ - "Computation", - "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to analyze data.", - "permissions": [ - "ANALYZE" - ] + "summary" : "(BETA) Valid descendants", + "tags" : [ "Computation", "actions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to analyze data.", + "permissions" : [ "ANALYZE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects": { - "post": { - "description": "Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable.", - "operationId": "computeValidObjects", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AfmValidObjectsQuery" + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects" : { + "post" : { + "description" : "Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable.", + "operationId" : "computeValidObjects", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AfmValidObjectsQuery" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AfmValidObjectsResponse" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AfmValidObjectsResponse" } } }, - "description": "List of attributes, facts and metrics valid with respect to given AFM." + "description" : "List of attributes, facts and metrics valid with respect to given AFM." } }, - "summary": "Valid objects", - "tags": [ - "Computation", - "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to view data.", - "permissions": [ - "VIEW" - ] + "summary" : "Valid objects", + "tags" : [ "Computation", "actions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to view data.", + "permissions" : [ "VIEW" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute": { - "post": { - "description": "AFM is a combination of attributes, measures and filters that describe a query you want to execute.", - "operationId": "computeReport", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "deprecated": true, - "example": "2020-06-03T10:15:30+01:00", - "in": "header", - "name": "timestamp", - "required": false, - "schema": { - "description": "Timestamp for the execution. Deprecated, use `settings.timestamp` in the request body.", - "format": "timestamp", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AfmExecution" + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute" : { + "post" : { + "description" : "AFM is a combination of attributes, measures and filters that describe a query you want to execute.", + "operationId" : "computeReport", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, { + "description" : "Ignore all caches during execution of current request.", + "in" : "header", + "name" : "skip-cache", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "deprecated" : true, + "example" : "2020-06-03T10:15:30+01:00", + "in" : "header", + "name" : "timestamp", + "required" : false, + "schema" : { + "description" : "Timestamp for the execution. Deprecated, use `settings.timestamp` in the request body.", + "format" : "timestamp", + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AfmExecution" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AfmExecutionResponse" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AfmExecutionResponse" } } }, - "description": "AFM Execution response with links to the result and server-enhanced dimensions from the original request.", - "headers": { - "X-GDC-CANCEL-TOKEN": { - "description": "A token that can be used to cancel this execution", - "schema": { - "type": "string" + "description" : "AFM Execution response with links to the result and server-enhanced dimensions from the original request.", + "headers" : { + "X-GDC-CANCEL-TOKEN" : { + "description" : "A token that can be used to cancel this execution", + "schema" : { + "type" : "string" }, - "style": "simple" + "style" : "simple" } } } }, - "summary": "Executes analytical request and returns link to the result", - "tags": [ - "Computation", - "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to view a report or label elements.", - "permissions": [ - "VIEW" - ] + "summary" : "Executes analytical request and returns link to the result", + "tags" : [ "Computation", "actions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to view a report or label elements.", + "permissions" : [ "VIEW" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}": { - "get": { - "description": "Gets a single execution result.", - "operationId": "retrieveResult", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", - "in": "path", - "name": "resultId", - "required": true, - "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", - "explode": false, - "in": "query", - "name": "offset", - "required": false, - "schema": { - "default": [], - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.", - "example": "limit=1,10", - "explode": false, - "in": "query", - "name": "limit", - "required": false, - "schema": { - "default": [], - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "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.", - "example": "excludedTotalDimensions=dim_0,dim_1", - "explode": false, - "in": "query", - "name": "excludedTotalDimensions", - "required": false, - "schema": { - "default": [], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-CANCEL-TOKEN", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExecutionResult" + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}" : { + "get" : { + "description" : "Gets a single execution result.", + "operationId" : "retrieveResult", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, { + "description" : "Result ID", + "example" : "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + "in" : "path", + "name" : "resultId", + "required" : true, + "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", + "explode" : false, + "in" : "query", + "name" : "offset", + "required" : false, + "schema" : { + "default" : [ ], + "items" : { + "format" : "int32", + "type" : "integer" + }, + "type" : "array" + }, + "style" : "form" + }, { + "description" : "Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.", + "example" : "limit=1,10", + "explode" : false, + "in" : "query", + "name" : "limit", + "required" : false, + "schema" : { + "default" : [ ], + "items" : { + "format" : "int32", + "type" : "integer" + }, + "type" : "array" + }, + "style" : "form" + }, { + "description" : "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.", + "example" : "excludedTotalDimensions=dim_0,dim_1", + "explode" : false, + "in" : "query", + "name" : "excludedTotalDimensions", + "required" : false, + "schema" : { + "default" : [ ], + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-CANCEL-TOKEN", + "required" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ExecutionResult" } } }, - "description": "Execution result was found and returned." + "description" : "Execution result was found and returned." } }, - "summary": "Get a single execution result", - "tags": [ - "Computation", - "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to view a report or label elements.", - "permissions": [ - "VIEW" - ] + "summary" : "Get a single execution result", + "tags" : [ "Computation", "actions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to view a report or label elements.", + "permissions" : [ "VIEW" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata": { - "get": { - "description": "The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse", - "operationId": "retrieveExecutionMetadata", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", - "in": "path", - "name": "resultId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ResultCacheMetadata" + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata" : { + "get" : { + "description" : "The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse", + "operationId" : "retrieveExecutionMetadata", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, { + "description" : "Result ID", + "example" : "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + "in" : "path", + "name" : "resultId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResultCacheMetadata" } } }, - "description": "Execution result's metadata was found and returned." + "description" : "Execution result's metadata was found and returned." } }, - "summary": "Get a single execution result's metadata.", - "tags": [ - "Computation", - "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to analyze data.", - "permissions": [ - "ANALYZE" - ] + "summary" : "Get a single execution result's metadata.", + "tags" : [ "Computation", "actions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to analyze data.", + "permissions" : [ "ANALYZE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/explain": { - "post": { - "description": "The resource provides static structures needed for investigation of a problem with given AFM.", - "operationId": "explainAFM", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Requested explain type. If not specified all types are bundled in a ZIP archive.\n\n`MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info\n\n`GRPC_MODEL` - Datasets used in execution\n\n`GRPC_MODEL_SVG` - Generated SVG image of the datasets\n\n`COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query\n\n`WDF` - Workspace data filters in execution workspace context\n\n`QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL\n\n`QT_SVG` - Generated SVG image of the Query Tree\n\n`OPT_QT` - Optimized Query Tree\n\n`OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree\n\n`SQL` - Final SQL to be executed\n\n`COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets\n\n`SETTINGS` - Settings used to execute explain request", - "in": "query", - "name": "explainType", - "required": false, - "schema": { - "enum": [ - "MAQL", - "GRPC_MODEL", - "GRPC_MODEL_SVG", - "WDF", - "QT", - "QT_SVG", - "OPT_QT", - "OPT_QT_SVG", - "SQL", - "SETTINGS", - "COMPRESSED_SQL" - ], - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AfmExecution" + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/explain" : { + "post" : { + "description" : "The resource provides static structures needed for investigation of a problem with given AFM.", + "operationId" : "explainAFM", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, { + "description" : "Requested explain type. If not specified all types are bundled in a ZIP archive.\n\n`MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info\n\n`GRPC_MODEL` - Datasets used in execution\n\n`GRPC_MODEL_SVG` - Generated SVG image of the datasets\n\n`COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query\n\n`WDF` - Workspace data filters in execution workspace context\n\n`QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL\n\n`QT_SVG` - Generated SVG image of the Query Tree\n\n`OPT_QT` - Optimized Query Tree\n\n`OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree\n\n`SQL` - Final SQL to be executed\n\n`COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets\n\n`SETTINGS` - Settings used to execute explain request", + "in" : "query", + "name" : "explainType", + "required" : false, + "schema" : { + "enum" : [ "MAQL", "GRPC_MODEL", "GRPC_MODEL_SVG", "WDF", "QT", "QT_SVG", "OPT_QT", "OPT_QT_SVG", "SQL", "SETTINGS", "COMPRESSED_SQL" ], + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AfmExecution" } } }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": {}, - "application/sql": {}, - "application/zip": { - "schema": { - "description": "ZIP with MAQL, GRPC_MODEL, GRPC_MODEL_SVG, WDF, QT, QT_SVG, OPT_QT, OPT_QT_SVG and SQL files", - "format": "binary", - "type": "string" + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { }, + "application/sql" : { }, + "application/zip" : { + "schema" : { + "description" : "ZIP with MAQL, GRPC_MODEL, GRPC_MODEL_SVG, WDF, QT, QT_SVG, OPT_QT, OPT_QT_SVG and SQL files", + "format" : "binary", + "type" : "string" } }, - "image/svg+xml": {} + "image/svg+xml" : { } }, - "description": "Requested resource" + "description" : "Requested resource" } }, - "summary": "AFM explain resource.", - "tags": [ - "Computation", - "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to analyze data.", - "permissions": [ - "ANALYZE" - ] + "summary" : "AFM explain resource.", + "tags" : [ "Computation", "actions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to analyze data.", + "permissions" : [ "ANALYZE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements": { - "post": { - "description": "Returns paged list of elements (values) of given label satisfying given filtering criteria.", - "operationId": "computeLabelElementsPost", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.", - "in": "query", - "name": "offset", - "required": false, - "schema": { - "default": 0, - "format": "int32", - "maximum": 10000, - "minimum": 0, - "type": "integer" - } - }, - { - "description": "Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.", - "in": "query", - "name": "limit", - "required": false, - "schema": { - "default": 1000, - "format": "int32", - "maximum": 10000, - "minimum": 1, - "type": "integer" - } - }, - { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ElementsRequest" + "/api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements" : { + "post" : { + "description" : "Returns paged list of elements (values) of given label satisfying given filtering criteria.", + "operationId" : "computeLabelElementsPost", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, { + "description" : "Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.", + "in" : "query", + "name" : "offset", + "required" : false, + "schema" : { + "default" : 0, + "format" : "int32", + "maximum" : 10000, + "minimum" : 0, + "type" : "integer" + } + }, { + "description" : "Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.", + "in" : "query", + "name" : "limit", + "required" : false, + "schema" : { + "default" : 1000, + "format" : "int32", + "maximum" : 10000, + "minimum" : 1, + "type" : "integer" + } + }, { + "description" : "Ignore all caches during execution of current request.", + "in" : "header", + "name" : "skip-cache", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ElementsRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ElementsResponse" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ElementsResponse" } } }, - "description": "List of label values." + "description" : "List of label values." } }, - "summary": "Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.", - "tags": [ - "Computation", - "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to view a report or label elements.", - "permissions": [ - "VIEW" - ] + "summary" : "Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.", + "tags" : [ "Computation", "actions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to view a report or label elements.", + "permissions" : [ "VIEW" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis": { - "post": { - "description": "Computes change analysis for the provided execution definition.", - "operationId": "changeAnalysis", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeAnalysisRequest" + "/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis" : { + "post" : { + "description" : "Computes change analysis for the provided execution definition.", + "operationId" : "changeAnalysis", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ChangeAnalysisRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeAnalysisResponse" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ChangeAnalysisResponse" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "Compute change analysis", - "tags": [ - "Computation", - "actions" - ] + "summary" : "Compute change analysis", + "tags" : [ "Computation", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis/result/{resultId}": { - "get": { - "description": "Gets change analysis result.", - "operationId": "changeAnalysisResult", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", - "in": "path", - "name": "resultId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangeAnalysisResult" + "/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis/result/{resultId}" : { + "get" : { + "description" : "Gets change analysis result.", + "operationId" : "changeAnalysisResult", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, { + "description" : "Result ID", + "example" : "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + "in" : "path", + "name" : "resultId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ChangeAnalysisResult" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "Get change analysis result", - "tags": [ - "Computation", - "actions" - ] + "summary" : "Get change analysis result", + "tags" : [ "Computation", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers": { - "post": { - "description": "(EXPERIMENTAL) Computes key driver analysis for the provided execution definition.", - "operationId": "keyDriverAnalysis", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KeyDriversRequest" + "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers" : { + "post" : { + "description" : "(EXPERIMENTAL) Computes key driver analysis for the provided execution definition.", + "operationId" : "keyDriverAnalysis", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, { + "description" : "Ignore all caches during execution of current request.", + "in" : "header", + "name" : "skip-cache", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/KeyDriversRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KeyDriversResponse" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/KeyDriversResponse" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "(EXPERIMENTAL) Compute key driver analysis", - "tags": [ - "Computation", - "actions" - ] + "summary" : "(EXPERIMENTAL) Compute key driver analysis", + "tags" : [ "Computation", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId}": { - "get": { - "description": "(EXPERIMENTAL) Gets key driver analysis.", - "operationId": "keyDriverAnalysisResult", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", - "in": "path", - "name": "resultId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "offset", - "required": false, - "schema": { - "format": "int32", - "type": "integer" - } - }, - { - "in": "query", - "name": "limit", - "required": false, - "schema": { - "format": "int32", - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KeyDriversResult" + "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId}" : { + "get" : { + "description" : "(EXPERIMENTAL) Gets key driver analysis.", + "operationId" : "keyDriverAnalysisResult", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, { + "description" : "Result ID", + "example" : "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + "in" : "path", + "name" : "resultId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "offset", + "required" : false, + "schema" : { + "format" : "int32", + "type" : "integer" + } + }, { + "in" : "query", + "name" : "limit", + "required" : false, + "schema" : { + "format" : "int32", + "type" : "integer" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/KeyDriversResult" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "(EXPERIMENTAL) Get key driver analysis result", - "tags": [ - "Computation", - "actions" - ] + "summary" : "(EXPERIMENTAL) Get key driver analysis result", + "tags" : [ "Computation", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers": { - "post": { - "description": "(BETA) Computes outlier detection for the provided execution definition.", - "operationId": "outlierDetection", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OutlierDetectionRequest" + "/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers" : { + "post" : { + "description" : "(BETA) Computes outlier detection for the provided execution definition.", + "operationId" : "outlierDetection", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, { + "description" : "Ignore all caches during execution of current request.", + "in" : "header", + "name" : "skip-cache", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/OutlierDetectionRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OutlierDetectionResponse" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/OutlierDetectionResponse" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "(BETA) Outlier Detection", - "tags": [ - "Computation", - "actions" - ] + "summary" : "(BETA) Outlier Detection", + "tags" : [ "Computation", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers/result/{resultId}": { - "get": { - "description": "(BETA) Gets outlier detection result.", - "operationId": "outlierDetectionResult", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", - "in": "path", - "name": "resultId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "offset", - "required": false, - "schema": { - "format": "int32", - "type": "integer" - } - }, - { - "in": "query", - "name": "limit", - "required": false, - "schema": { - "format": "int32", - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OutlierDetectionResult" + "/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers/result/{resultId}" : { + "get" : { + "description" : "(BETA) Gets outlier detection result.", + "operationId" : "outlierDetectionResult", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, { + "description" : "Result ID", + "example" : "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + "in" : "path", + "name" : "resultId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "offset", + "required" : false, + "schema" : { + "format" : "int32", + "type" : "integer" + } + }, { + "in" : "query", + "name" : "limit", + "required" : false, + "schema" : { + "format" : "int32", + "type" : "integer" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/OutlierDetectionResult" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "(BETA) Outlier Detection Result", - "tags": [ - "Computation", - "actions" - ] + "summary" : "(BETA) Outlier Detection Result", + "tags" : [ "Computation", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId}": { - "get": { - "description": "(EXPERIMENTAL) Gets anomalies.", - "operationId": "anomalyDetectionResult", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", - "in": "path", - "name": "resultId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "offset", - "required": false, - "schema": { - "format": "int32", - "type": "integer" - } - }, - { - "in": "query", - "name": "limit", - "required": false, - "schema": { - "format": "int32", - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnomalyDetectionResult" + "/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId}" : { + "get" : { + "description" : "(EXPERIMENTAL) Gets anomalies.", + "operationId" : "anomalyDetectionResult", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, { + "description" : "Result ID", + "example" : "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + "in" : "path", + "name" : "resultId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "offset", + "required" : false, + "schema" : { + "format" : "int32", + "type" : "integer" + } + }, { + "in" : "query", + "name" : "limit", + "required" : false, + "schema" : { + "format" : "int32", + "type" : "integer" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AnomalyDetectionResult" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "(EXPERIMENTAL) Smart functions - Anomaly Detection Result", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "(EXPERIMENTAL) Smart functions - Anomaly Detection Result", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId}": { - "post": { - "description": "(EXPERIMENTAL) Computes anomaly detection.", - "operationId": "anomalyDetection", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Input result ID to be used in the computation", - "example": "9bd52018570364264fcf62d373da6bed313120e8", - "in": "path", - "name": "resultId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnomalyDetectionRequest" + "/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId}" : { + "post" : { + "description" : "(EXPERIMENTAL) Computes anomaly detection.", + "operationId" : "anomalyDetection", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, { + "description" : "Input result ID to be used in the computation", + "example" : "9bd52018570364264fcf62d373da6bed313120e8", + "in" : "path", + "name" : "resultId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Ignore all caches during execution of current request.", + "in" : "header", + "name" : "skip-cache", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AnomalyDetectionRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SmartFunctionResponse" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SmartFunctionResponse" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "(EXPERIMENTAL) Smart functions - Anomaly Detection", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "(EXPERIMENTAL) Smart functions - Anomaly Detection", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/result/{resultId}": { - "get": { - "description": "(EXPERIMENTAL) Gets clustering result.", - "operationId": "clusteringResult", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", - "in": "path", - "name": "resultId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "offset", - "required": false, - "schema": { - "format": "int32", - "type": "integer" - } - }, - { - "in": "query", - "name": "limit", - "required": false, - "schema": { - "format": "int32", - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClusteringResult" + "/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/result/{resultId}" : { + "get" : { + "description" : "(EXPERIMENTAL) Gets clustering result.", + "operationId" : "clusteringResult", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, { + "description" : "Result ID", + "example" : "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + "in" : "path", + "name" : "resultId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "offset", + "required" : false, + "schema" : { + "format" : "int32", + "type" : "integer" + } + }, { + "in" : "query", + "name" : "limit", + "required" : false, + "schema" : { + "format" : "int32", + "type" : "integer" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusteringResult" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "(EXPERIMENTAL) Smart functions - Clustering Result", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "(EXPERIMENTAL) Smart functions - Clustering Result", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId}": { - "post": { - "description": "(EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.", - "operationId": "clustering", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Input result ID to be used in the computation", - "example": "9bd52018570364264fcf62d373da6bed313120e8", - "in": "path", - "name": "resultId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClusteringRequest" + "/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId}" : { + "post" : { + "description" : "(EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.", + "operationId" : "clustering", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, { + "description" : "Input result ID to be used in the computation", + "example" : "9bd52018570364264fcf62d373da6bed313120e8", + "in" : "path", + "name" : "resultId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Ignore all caches during execution of current request.", + "in" : "header", + "name" : "skip-cache", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusteringRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SmartFunctionResponse" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SmartFunctionResponse" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "(EXPERIMENTAL) Smart functions - Clustering", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "(EXPERIMENTAL) Smart functions - Clustering", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId}": { - "get": { - "description": "(BETA) Gets forecast result.", - "operationId": "forecastResult", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", - "in": "path", - "name": "resultId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "offset", - "required": false, - "schema": { - "format": "int32", - "type": "integer" - } - }, - { - "in": "query", - "name": "limit", - "required": false, - "schema": { - "format": "int32", - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ForecastResult" + "/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId}" : { + "get" : { + "description" : "(BETA) Gets forecast result.", + "operationId" : "forecastResult", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, { + "description" : "Result ID", + "example" : "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + "in" : "path", + "name" : "resultId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "offset", + "required" : false, + "schema" : { + "format" : "int32", + "type" : "integer" + } + }, { + "in" : "query", + "name" : "limit", + "required" : false, + "schema" : { + "format" : "int32", + "type" : "integer" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ForecastResult" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "(BETA) Smart functions - Forecast Result", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "(BETA) Smart functions - Forecast Result", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId}": { - "post": { - "description": "(BETA) Computes forecasted data points from the provided execution result and parameters.", - "operationId": "forecast", - "parameters": [ - { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Input result ID to be used in the computation", - "example": "9bd52018570364264fcf62d373da6bed313120e8", - "in": "path", - "name": "resultId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ForecastRequest" + "/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId}" : { + "post" : { + "description" : "(BETA) Computes forecasted data points from the provided execution result and parameters.", + "operationId" : "forecast", + "parameters" : [ { + "description" : "Workspace identifier", + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, { + "description" : "Input result ID to be used in the computation", + "example" : "9bd52018570364264fcf62d373da6bed313120e8", + "in" : "path", + "name" : "resultId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Ignore all caches during execution of current request.", + "in" : "header", + "name" : "skip-cache", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ForecastRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SmartFunctionResponse" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SmartFunctionResponse" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "(BETA) Smart functions - Forecast", - "tags": [ - "Smart Functions", - "actions" - ] + "summary" : "(BETA) Smart functions - Forecast", + "tags" : [ "Smart Functions", "actions" ] } }, - "/api/v1/ailake/database/instance": { - "post": { - "description": "(BETA) Creates a new database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.", - "operationId": "provisionAiLakeDatabaseInstance", - "parameters": [ - { - "in": "header", - "name": "operation-id", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProvisionDatabaseInstanceRequest" + "/api/v1/ailake/database/instance" : { + "post" : { + "description" : "(BETA) Creates a new database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.", + "operationId" : "provisionAiLakeDatabaseInstance", + "parameters" : [ { + "in" : "header", + "name" : "operation-id", + "required" : false, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ProvisionDatabaseInstanceRequest" } } }, - "required": true + "required" : true }, - "responses": { - "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" + "responses" : { + "202" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Unit" } } }, - "description": "Accepted", - "headers": { - "operation-id": { - "description": "Operation ID to use for polling.", - "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, - "schema": { - "type": "string" + "description" : "Accepted", + "headers" : { + "operation-id" : { + "description" : "Operation ID to use for polling.", + "example" : "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required" : true, + "schema" : { + "type" : "string" }, - "style": "simple" + "style" : "simple" }, - "operation-location": { - "description": "Operation location URL that can be used for polling.", - "example": "/api/v1/ailake/operation/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, - "schema": { - "type": "string" + "operation-location" : { + "description" : "Operation location URL that can be used for polling.", + "example" : "/api/v1/ailake/operation/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required" : true, + "schema" : { + "type" : "string" }, - "style": "simple" + "style" : "simple" } } } }, - "summary": "(BETA) Create a new AILake Database instance", - "tags": [ - "AI Lake" - ], - "x-gdc-security-info": { - "description": "Permissions required to provision an AI Lake database instance.", - "permissions": [ - "MANAGE" - ] + "summary" : "(BETA) Create a new AILake Database instance", + "tags" : [ "AI Lake" ], + "x-gdc-security-info" : { + "description" : "Permissions required to provision an AI Lake database instance.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/ailake/database/instance/{instanceId}": { - "delete": { - "description": "(BETA) Deletes an existing database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.", - "operationId": "deprovisionAiLakeDatabaseInstance", - "parameters": [ - { - "in": "path", - "name": "instanceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "operation-id", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "202": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" + "/api/v1/ailake/database/instance/{instanceId}" : { + "delete" : { + "description" : "(BETA) Deletes an existing database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.", + "operationId" : "deprovisionAiLakeDatabaseInstance", + "parameters" : [ { + "in" : "path", + "name" : "instanceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "operation-id", + "required" : false, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Unit" } } }, - "description": "Accepted", - "headers": { - "operation-id": { - "description": "Operation ID to use for polling.", - "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, - "schema": { - "type": "string" + "description" : "Accepted", + "headers" : { + "operation-id" : { + "description" : "Operation ID to use for polling.", + "example" : "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required" : true, + "schema" : { + "type" : "string" }, - "style": "simple" + "style" : "simple" }, - "operation-location": { - "description": "Operation location URL that can be used for polling.", - "example": "/api/v1/ailake/operation/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, - "schema": { - "type": "string" + "operation-location" : { + "description" : "Operation location URL that can be used for polling.", + "example" : "/api/v1/ailake/operation/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required" : true, + "schema" : { + "type" : "string" }, - "style": "simple" + "style" : "simple" } } } }, - "summary": "(BETA) Delete an existing AILake Database instance", - "tags": [ - "AI Lake" - ], - "x-gdc-security-info": { - "description": "Permissions required to provision an AI Lake database instance.", - "permissions": [ - "MANAGE" - ] + "summary" : "(BETA) Delete an existing AILake Database instance", + "tags" : [ "AI Lake" ], + "x-gdc-security-info" : { + "description" : "Permissions required to provision an AI Lake database instance.", + "permissions" : [ "MANAGE" ] } }, - "get": { - "description": "(BETA) Retrieve details of the specified AI Lake database instance in the organization's AI Lake.", - "operationId": "getAiLakeDatabaseInstance", - "parameters": [ - { - "in": "path", - "name": "instanceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DatabaseInstance" + "get" : { + "description" : "(BETA) Retrieve details of the specified AI Lake database instance in the organization's AI Lake.", + "operationId" : "getAiLakeDatabaseInstance", + "parameters" : [ { + "in" : "path", + "name" : "instanceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DatabaseInstance" } } }, - "description": "AI Lake database instance successfully retrieved" + "description" : "AI Lake database instance successfully retrieved" } }, - "summary": "(BETA) Get the specified AILake Database instance", - "tags": [ - "AI Lake" - ], - "x-gdc-security-info": { - "description": "Permissions required to get an AI Lake database instance.", - "permissions": [ - "MANAGE" - ] + "summary" : "(BETA) Get the specified AILake Database instance", + "tags" : [ "AI Lake" ], + "x-gdc-security-info" : { + "description" : "Permissions required to get an AI Lake database instance.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/ailake/operation/{operationId}": { - "get": { - "description": "(BETA) Retrieves details of a Long Running Operation specified by the operation-id.", - "operationId": "getAiLakeOperation", - "parameters": [ - { - "description": "Operation ID", - "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "in": "path", - "name": "operationId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/FailedOperation" - }, - { - "$ref": "#/components/schemas/PendingOperation" - }, - { - "$ref": "#/components/schemas/SucceededOperation" - } - ] + "/api/v1/ailake/operation/{operationId}" : { + "get" : { + "description" : "(BETA) Retrieves details of a Long Running Operation specified by the operation-id.", + "operationId" : "getAiLakeOperation", + "parameters" : [ { + "description" : "Operation ID", + "example" : "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "in" : "path", + "name" : "operationId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/FailedOperation" + }, { + "$ref" : "#/components/schemas/PendingOperation" + }, { + "$ref" : "#/components/schemas/SucceededOperation" + } ] } } }, - "description": "AI Lake Long Running Operation details successfully retrieved" + "description" : "AI Lake Long Running Operation details successfully retrieved" } }, - "summary": "(BETA) Get Long Running Operation details", - "tags": [ - "AI Lake" - ], - "x-gdc-security-info": { - "description": "Permissions required to get details of a Long Running Operation.", - "permissions": [ - "MANAGE" - ] + "summary" : "(BETA) Get Long Running Operation details", + "tags" : [ "AI Lake" ], + "x-gdc-security-info" : { + "description" : "Permissions required to get details of a Long Running Operation.", + "permissions" : [ "MANAGE" ] } } } }, - "servers": [ - { - "description": "GoodData.CN endpoint", - "url": "/" - } - ], - "tags": [ - { - "description": "| APIs for interaction with the AI Lake", - "name": "AI Lake" - }, - { - "description": "| execution of some form of computation (RPC over JSON)", - "name": "actions" - } - ] -} + "servers" : [ { + "description" : "GoodData.CN endpoint", + "url" : "/" + } ], + "tags" : [ { + "description" : "| APIs for interaction with the AI Lake", + "name" : "AI Lake" + }, { + "description" : "| execution of some form of computation (RPC over JSON)", + "name" : "actions" + } ] +} \ No newline at end of file diff --git a/schemas/gooddata-api-client.json b/schemas/gooddata-api-client.json index d94473b65..c21ff90e9 100644 --- a/schemas/gooddata-api-client.json +++ b/schemas/gooddata-api-client.json @@ -4475,10 +4475,6 @@ "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", "type": "string" }, - "includeEmptyValues": { - "description": "If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).", - "type": "boolean" - }, "localIdentifier": { "type": "string" }, @@ -4650,6 +4646,7 @@ "properties": { "resultIdToCancelTokenPairs": { "additionalProperties": { + "description": "resultId to cancel token pairs", "type": "string" }, "description": "resultId to cancel token pairs", @@ -4817,7 +4814,7 @@ "type": "object" }, "AfmObjectIdentifierDataset": { - "description": "Reference to the date dataset to which the filter should be applied.", + "description": "Date dataset used for anomaly detection.", "properties": { "identifier": { "properties": { @@ -5410,12 +5407,6 @@ ], "type": "object" }, - "Array": { - "items": { - "type": "string" - }, - "type": "array" - }, "AssigneeIdentifier": { "description": "Identifier of a user or user-group.", "properties": { @@ -5794,12 +5785,24 @@ "execution": { "$ref": "#/components/schemas/AlertAfm" }, + "interval": { + "description": "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", + "enum": [ + "DAY", + "WEEK", + "MONTH", + "QUARTER", + "YEAR" + ], + "type": "string" + }, "trigger": { "default": "ALWAYS", - "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\n", + "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", "enum": [ "ALWAYS", - "ONCE" + "ONCE", + "ONCE_PER_INTERVAL" ], "type": "string" } @@ -5846,7 +5849,6 @@ "type": "object" }, "AutomationMetadata": { - "additionalProperties": true, "description": "Additional information for the automation.", "maxLength": 250000, "nullable": true, @@ -7222,9 +7224,6 @@ ], "type": "string" }, - "includeEmptyValues": { - "type": "boolean" - }, "localIdentifier": { "type": "string" }, @@ -8581,6 +8580,7 @@ "description": "Column name", "example": "customer_id", "maxLength": 255, + "pattern": "^[^\u0000]*$", "type": "string" }, "referencedTableColumn": { @@ -8631,7 +8631,11 @@ "type": "string" }, "content": { - "$ref": "#/components/schemas/JsonNode" + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": {}, + "maxLength": 250000, + "nullable": true, + "type": "object" }, "id": { "description": "Custom Application Setting ID.", @@ -8650,11 +8654,22 @@ "DeclarativeCustomGeoCollection": { "description": "A declarative form of custom geo collection.", "properties": { + "description": { + "description": "Description of the custom geo collection.", + "maxLength": 10000, + "type": "string" + }, "id": { "description": "Custom geo collection ID.", "example": "my-geo-collection", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" + }, + "name": { + "description": "Name of the custom geo collection.", + "example": "My Geo Collection", + "maxLength": 255, + "type": "string" } }, "required": [ @@ -8871,7 +8886,8 @@ "STARROCKS", "ATHENA", "MONGODB", - "CRATEDB" + "CRATEDB", + "AILAKEHOUSE" ], "example": "POSTGRESQL", "type": "string" @@ -9478,6 +9494,8 @@ "properties": { "customClaimMapping": { "additionalProperties": { + "description": "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name, urn.gooddata.user_groups [optional]). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", + "maxLength": 10000, "type": "string" }, "description": "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name, urn.gooddata.user_groups [optional]). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", @@ -12355,16 +12373,25 @@ "YES", "NO" ], - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "id": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "notes": { "$ref": "#/components/schemas/Notes" }, "original": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "otherAttributes": { "additionalProperties": { @@ -12376,7 +12403,11 @@ "$ref": "#/components/schemas/Skeleton" }, "space": { - "type": "string" + "type": "string", + "xml": { + "attribute": true, + "namespace": "http://www.w3.org/XML/1998/namespace" + } }, "srcDir": { "enum": [ @@ -12384,14 +12415,20 @@ "RTL", "AUTO" ], - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "translate": { "enum": [ "YES", "NO" ], - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "trgDir": { "enum": [ @@ -12399,7 +12436,10 @@ "RTL", "AUTO" ], - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "unitOrGroup": { "items": { @@ -12408,7 +12448,11 @@ "type": "array" } }, - "type": "object" + "type": "object", + "xml": { + "name": "file", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } }, "Filter": { "description": "List of filters to be applied to the new visualization", @@ -13528,7 +13572,10 @@ "type": "object" }, "createdAt": { + "description": "Time of the entity creation.", "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "description": { @@ -13536,7 +13583,10 @@ "type": "string" }, "modifiedAt": { + "description": "Time of the last entity modification.", "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "summary": { @@ -14241,7 +14291,10 @@ "type": "object" }, "createdAt": { + "description": "Time of the entity creation.", "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "description": { @@ -14249,7 +14302,10 @@ "type": "string" }, "modifiedAt": { + "description": "Time of the last entity modification.", "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "tags": { @@ -14893,12 +14949,24 @@ "execution": { "$ref": "#/components/schemas/AlertAfm" }, + "interval": { + "description": "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", + "enum": [ + "DAY", + "WEEK", + "MONTH", + "QUARTER", + "YEAR" + ], + "type": "string" + }, "trigger": { "default": "ALWAYS", - "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\n", + "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", "enum": [ "ALWAYS", - "ONCE" + "ONCE", + "ONCE_PER_INTERVAL" ], "type": "string" } @@ -14975,7 +15043,6 @@ "type": "array" }, "metadata": { - "additionalProperties": true, "description": "Additional information for the automation.", "maxLength": 250000, "nullable": true, @@ -15214,12 +15281,24 @@ "execution": { "$ref": "#/components/schemas/AlertAfm" }, + "interval": { + "description": "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", + "enum": [ + "DAY", + "WEEK", + "MONTH", + "QUARTER", + "YEAR" + ], + "type": "string" + }, "trigger": { "default": "ALWAYS", - "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\n", + "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", "enum": [ "ALWAYS", - "ONCE" + "ONCE", + "ONCE_PER_INTERVAL" ], "type": "string" } @@ -15234,7 +15313,10 @@ "type": "boolean" }, "createdAt": { + "description": "Time of the entity creation.", "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "dashboardTabularExports": { @@ -15300,7 +15382,6 @@ "type": "array" }, "metadata": { - "additionalProperties": true, "description": "Additional information for the automation.", "maxLength": 250000, "nullable": true, @@ -15318,7 +15399,10 @@ "type": "object" }, "modifiedAt": { + "description": "Time of the last entity modification.", "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "rawExports": { @@ -15661,12 +15745,24 @@ "execution": { "$ref": "#/components/schemas/AlertAfm" }, + "interval": { + "description": "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", + "enum": [ + "DAY", + "WEEK", + "MONTH", + "QUARTER", + "YEAR" + ], + "type": "string" + }, "trigger": { "default": "ALWAYS", - "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\n", + "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", "enum": [ "ALWAYS", - "ONCE" + "ONCE", + "ONCE_PER_INTERVAL" ], "type": "string" } @@ -15743,7 +15839,6 @@ "type": "array" }, "metadata": { - "additionalProperties": true, "description": "Additional information for the automation.", "maxLength": 250000, "nullable": true, @@ -16646,7 +16741,7 @@ "type": "string" }, "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": {}, "type": "object" } @@ -16700,7 +16795,7 @@ "type": "string" }, "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": {}, "type": "object" } @@ -16820,7 +16915,7 @@ "type": "string" }, "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": {}, "type": "object" } @@ -16870,7 +16965,7 @@ "type": "string" }, "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": {}, "type": "object" } @@ -16916,6 +17011,21 @@ "JsonApiCustomGeoCollectionIn": { "description": "JSON:API representation of customGeoCollection entity.", "properties": { + "attributes": { + "properties": { + "description": { + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "name": { + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, "id": { "description": "API identifier of an object", "example": "id1", @@ -16951,6 +17061,21 @@ "JsonApiCustomGeoCollectionOut": { "description": "JSON:API representation of customGeoCollection entity.", "properties": { + "attributes": { + "properties": { + "description": { + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "name": { + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, "id": { "description": "API identifier of an object", "example": "id1", @@ -17026,6 +17151,21 @@ "JsonApiCustomGeoCollectionPatch": { "description": "JSON:API representation of patching customGeoCollection entity.", "properties": { + "attributes": { + "properties": { + "description": { + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "name": { + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, "id": { "description": "API identifier of an object", "example": "id1", @@ -17157,7 +17297,10 @@ "type": "object" }, "createdAt": { + "description": "Time of the entity creation.", "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "description": { @@ -17165,7 +17308,10 @@ "type": "string" }, "modifiedAt": { + "description": "Time of the last entity modification.", "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "tags": { @@ -17497,7 +17643,8 @@ "STARROCKS", "ATHENA", "MONGODB", - "CRATEDB" + "CRATEDB", + "AILAKEHOUSE" ], "type": "string" } @@ -17714,7 +17861,8 @@ "STARROCKS", "ATHENA", "MONGODB", - "CRATEDB" + "CRATEDB", + "AILAKEHOUSE" ], "type": "string" }, @@ -17889,7 +18037,8 @@ "STARROCKS", "ATHENA", "MONGODB", - "CRATEDB" + "CRATEDB", + "AILAKEHOUSE" ], "type": "string" }, @@ -18118,7 +18267,8 @@ "STARROCKS", "ATHENA", "MONGODB", - "CRATEDB" + "CRATEDB", + "AILAKEHOUSE" ], "type": "string" }, @@ -18861,7 +19011,10 @@ "type": "boolean" }, "createdAt": { + "description": "Time of the entity creation.", "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "description": { @@ -18869,7 +19022,10 @@ "type": "string" }, "modifiedAt": { + "description": "Time of the last entity modification.", "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "requestPayload": { @@ -22922,7 +23078,10 @@ "type": "boolean" }, "createdAt": { + "description": "Time of the entity creation.", "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "description": { @@ -22946,7 +23105,10 @@ "type": "array" }, "modifiedAt": { + "description": "Time of the last entity modification.", "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "strategy": { @@ -23430,7 +23592,10 @@ "type": "object" }, "createdAt": { + "description": "Time of the entity creation.", "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "description": { @@ -23444,7 +23609,10 @@ "type": "boolean" }, "modifiedAt": { + "description": "Time of the last entity modification.", "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "tags": { @@ -26923,7 +27091,10 @@ "type": "object" }, "createdAt": { + "description": "Time of the entity creation.", "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "description": { @@ -26934,7 +27105,10 @@ "type": "boolean" }, "modifiedAt": { + "description": "Time of the last entity modification.", "format": "date-time", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "tags": { @@ -27325,12 +27499,24 @@ "execution": { "$ref": "#/components/schemas/AlertAfm" }, + "interval": { + "description": "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", + "enum": [ + "DAY", + "WEEK", + "MONTH", + "QUARTER", + "YEAR" + ], + "type": "string" + }, "trigger": { "default": "ALWAYS", - "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\n", + "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", "enum": [ "ALWAYS", - "ONCE" + "ONCE", + "ONCE_PER_INTERVAL" ], "type": "string" } @@ -27411,7 +27597,6 @@ "type": "array" }, "metadata": { - "additionalProperties": true, "description": "Additional information for the automation.", "maxLength": 250000, "nullable": true, @@ -29315,7 +29500,7 @@ ] }, "JsonNode": { - "description": "Free-form JSON object", + "description": "Metadata definition in free-form JSON format.", "example": {}, "maxLength": 15000, "nullable": true, @@ -29871,16 +30056,25 @@ "SOURCE", "TARGET" ], - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "category": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "content": { "type": "string" }, "id": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "otherAttributes": { "additionalProperties": { @@ -29890,10 +30084,17 @@ }, "priority": { "format": "int32", - "type": "integer" + "type": "integer", + "xml": { + "attribute": true + } } }, - "type": "object" + "type": "object", + "xml": { + "name": "note", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } }, "Notes": { "properties": { @@ -29904,7 +30105,14 @@ "type": "array" } }, - "type": "object" + "required": [ + "note" + ], + "type": "object", + "xml": { + "name": "notes", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } }, "Notification": { "properties": { @@ -31398,10 +31606,6 @@ "example": "DAY", "type": "string" }, - "includeEmptyValues": { - "description": "If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).", - "type": "boolean" - }, "localIdentifier": { "type": "string" }, @@ -31696,6 +31900,9 @@ "type": "string" }, "kid": { + "maxLength": 255, + "minLength": 0, + "pattern": "^[^.]", "type": "string" }, "kty": { @@ -32292,10 +32499,17 @@ "type": "array" }, "href": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } } }, - "type": "object" + "type": "object", + "xml": { + "name": "skeleton", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } }, "SlidesExportRequest": { "description": "Export request object describing the export properties and metadata for slides exports.", @@ -33035,11 +33249,11 @@ "type": "object" }, "TestResponse": { - "description": "Response from data source testing.", + "description": "Response from notification channel testing.", "properties": { "error": { "description": "Field containing more details in case of a failure. Details are available to a privileged user only.", - "example": "Connection exception: Failed to initialize pool: FATAL: password authentication failed for user \"user\"", + "example": "Authentication failed", "type": "string" }, "queryDurationMillis": { @@ -34207,19 +34421,39 @@ "type": "object" }, "space": { - "type": "string" + "type": "string", + "xml": { + "attribute": true, + "namespace": "http://www.w3.org/XML/1998/namespace" + } }, "srcLang": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "trgLang": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } }, "version": { - "type": "string" + "type": "string", + "xml": { + "attribute": true + } } }, - "type": "object" + "required": [ + "file" + ], + "type": "object", + "xml": { + "name": "xliff", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } } } }, @@ -41345,7 +41579,7 @@ "parameters": [ { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -41457,7 +41691,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -41484,7 +41718,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -41523,7 +41757,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -41577,7 +41811,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -46198,7 +46432,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all", + "example": "metaInclude=permissions,config,hierarchy,dataModelDatasets,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -46207,8 +46441,8 @@ "description": "Included meta objects", "items": { "enum": [ - "config", "permissions", + "config", "hierarchy", "dataModelDatasets", "page", @@ -46279,7 +46513,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", + "example": "metaInclude=permissions,config,hierarchy,dataModelDatasets,all", "explode": false, "in": "query", "name": "metaInclude", @@ -46288,8 +46522,8 @@ "description": "Included meta objects", "items": { "enum": [ - "config", "permissions", + "config", "hierarchy", "dataModelDatasets", "all", @@ -46423,7 +46657,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", + "example": "metaInclude=permissions,config,hierarchy,dataModelDatasets,all", "explode": false, "in": "query", "name": "metaInclude", @@ -46432,8 +46666,8 @@ "description": "Included meta objects", "items": { "enum": [ - "config", "permissions", + "config", "hierarchy", "dataModelDatasets", "all", diff --git a/schemas/gooddata-automation-client.json b/schemas/gooddata-automation-client.json index e056de433..ecc05f8bb 100644 --- a/schemas/gooddata-automation-client.json +++ b/schemas/gooddata-automation-client.json @@ -1,3769 +1,3009 @@ { - "components": { - "schemas": { - "AFM": { - "description": "Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.", - "properties": { - "attributes": { - "description": "Attributes to be used in the computation.", - "items": { - "$ref": "#/components/schemas/AttributeItem" - }, - "type": "array" - }, - "auxMeasures": { - "description": "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "type": "array" - }, - "filters": { - "description": "Various filter types to filter the execution result.", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AbstractMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" - }, - { - "$ref": "#/components/schemas/InlineFilterDefinition" - } - ] - }, - "type": "array" - }, - "measures": { - "description": "Metrics to be computed.", - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "type": "array" - } - }, - "required": [ - "attributes", - "filters", - "measures" - ], - "type": "object" - }, - "AbsoluteDateFilter": { - "description": "A datetime filter specifying exact from and to values.", - "properties": { - "absoluteDateFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" - }, - "from": { - "example": "2020-07-01 18:23", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", - "type": "string" - }, - "includeEmptyValues": { - "description": "If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).", - "type": "boolean" - }, - "localIdentifier": { - "type": "string" - }, - "to": { - "example": "2020-07-16 23:59", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", - "type": "string" + "components" : { + "schemas" : { + "AFM" : { + "description" : "Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.", + "properties" : { + "attributes" : { + "description" : "Attributes to be used in the computation.", + "items" : { + "$ref" : "#/components/schemas/AttributeItem" + }, + "type" : "array" + }, + "auxMeasures" : { + "description" : "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", + "items" : { + "$ref" : "#/components/schemas/MeasureItem" + }, + "type" : "array" + }, + "filters" : { + "description" : "Various filter types to filter the execution result.", + "items" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/AbstractMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/FilterDefinitionForSimpleMeasure" + }, { + "$ref" : "#/components/schemas/InlineFilterDefinition" + } ] + }, + "type" : "array" + }, + "measures" : { + "description" : "Metrics to be computed.", + "items" : { + "$ref" : "#/components/schemas/MeasureItem" + }, + "type" : "array" + } + }, + "required" : [ "attributes", "filters", "measures" ], + "type" : "object" + }, + "AbsoluteDateFilter" : { + "description" : "A datetime filter specifying exact from and to values.", + "properties" : { + "absoluteDateFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "dataset" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierDataset" + }, + "from" : { + "example" : "2020-07-01 18:23", + "pattern" : "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "type" : "string" + }, + "localIdentifier" : { + "type" : "string" + }, + "to" : { + "example" : "2020-07-16 23:59", + "pattern" : "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "type" : "string" } }, - "required": [ - "from", - "to", - "dataset" - ], - "type": "object" + "required" : [ "from", "to", "dataset" ], + "type" : "object" } }, - "required": [ - "absoluteDateFilter" - ], - "type": "object" + "required" : [ "absoluteDateFilter" ], + "type" : "object" + }, + "AbstractMeasureValueFilter" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/ComparisonMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/RangeMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/CompoundMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/RankingFilter" + } ], + "type" : "object" }, - "AbstractMeasureValueFilter": { - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonMeasureValueFilter" + "AdHocAutomation" : { + "properties" : { + "alert" : { + "$ref" : "#/components/schemas/AutomationAlert" }, - { - "$ref": "#/components/schemas/RangeMeasureValueFilter" + "analyticalDashboard" : { + "$ref" : "#/components/schemas/DeclarativeAnalyticalDashboardIdentifier" }, - { - "$ref": "#/components/schemas/CompoundMeasureValueFilter" + "dashboardTabularExports" : { + "items" : { + "$ref" : "#/components/schemas/AutomationDashboardTabularExport" + }, + "type" : "array", + "uniqueItems" : true }, - { - "$ref": "#/components/schemas/RankingFilter" - } - ], - "type": "object" - }, - "AdHocAutomation": { - "properties": { - "alert": { - "$ref": "#/components/schemas/AutomationAlert" + "description" : { + "maxLength" : 255, + "type" : "string" }, - "analyticalDashboard": { - "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardIdentifier" + "details" : { + "additionalProperties" : { + "description" : "Additional details to be included in the automated message.", + "maxLength" : 10000, + "type" : "string" + }, + "description" : "Additional details to be included in the automated message.", + "maxLength" : 10000, + "type" : "object" }, - "dashboardTabularExports": { - "items": { - "$ref": "#/components/schemas/AutomationDashboardTabularExport" + "externalRecipients" : { + "description" : "External recipients of the automation action results.", + "items" : { + "$ref" : "#/components/schemas/AutomationExternalRecipient" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "description": { - "maxLength": 255, - "type": "string" + "imageExports" : { + "items" : { + "$ref" : "#/components/schemas/AutomationImageExport" + }, + "type" : "array", + "uniqueItems" : true }, - "details": { - "additionalProperties": { - "description": "Additional details to be included in the automated message.", - "maxLength": 10000, - "type": "string" + "metadata" : { + "$ref" : "#/components/schemas/AutomationMetadata" + }, + "notificationChannel" : { + "$ref" : "#/components/schemas/DeclarativeNotificationChannelIdentifier" + }, + "rawExports" : { + "items" : { + "$ref" : "#/components/schemas/AutomationRawExport" }, - "description": "Additional details to be included in the automated message.", - "maxLength": 10000, - "type": "object" + "type" : "array", + "uniqueItems" : true }, - "externalRecipients": { - "description": "External recipients of the automation action results.", - "items": { - "$ref": "#/components/schemas/AutomationExternalRecipient" + "recipients" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "imageExports": { - "items": { - "$ref": "#/components/schemas/AutomationImageExport" + "slidesExports" : { + "items" : { + "$ref" : "#/components/schemas/AutomationSlidesExport" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "metadata": { - "$ref": "#/components/schemas/AutomationMetadata" + "tabularExports" : { + "items" : { + "$ref" : "#/components/schemas/AutomationTabularExport" + }, + "type" : "array", + "uniqueItems" : true }, - "notificationChannel": { - "$ref": "#/components/schemas/DeclarativeNotificationChannelIdentifier" - }, - "rawExports": { - "items": { - "$ref": "#/components/schemas/AutomationRawExport" - }, - "type": "array", - "uniqueItems": true - }, - "recipients": { - "items": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "type": "array", - "uniqueItems": true - }, - "slidesExports": { - "items": { - "$ref": "#/components/schemas/AutomationSlidesExport" - }, - "type": "array", - "uniqueItems": true - }, - "tabularExports": { - "items": { - "$ref": "#/components/schemas/AutomationTabularExport" - }, - "type": "array", - "uniqueItems": true - }, - "tags": { - "description": "A list of tags.", - "example": [ - "Revenue", - "Sales" - ], - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "maxLength": 255, - "type": "string" - }, - "visualExports": { - "items": { - "$ref": "#/components/schemas/AutomationVisualExport" - }, - "type": "array", - "uniqueItems": true - } - }, - "type": "object" - }, - "AfmIdentifier": { - "description": "Reference to the attribute label to which the filter should be applied.", - "oneOf": [ - { - "$ref": "#/components/schemas/AfmObjectIdentifier" - }, - { - "$ref": "#/components/schemas/AfmLocalIdentifier" - } - ], - "type": "object" - }, - "AfmLocalIdentifier": { - "properties": { - "localIdentifier": { - "example": "sampleAutoGenerated0123_ID", - "pattern": "^[.a-zA-Z0-9_-]+$", - "type": "string" - } - }, - "required": [ - "localIdentifier" - ], - "type": "object" - }, - "AfmObjectIdentifier": { - "description": "ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.", - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "enum": [ - "analyticalDashboard", - "attribute", - "dashboardPlugin", - "dataset", - "fact", - "label", - "metric", - "prompt", - "visualizationObject", - "filterContext" - ], - "example": "fact", - "type": "string" + "tags" : { + "description" : "A list of tags.", + "example" : [ "Revenue", "Sales" ], + "items" : { + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "maxLength" : 255, + "type" : "string" + }, + "visualExports" : { + "items" : { + "$ref" : "#/components/schemas/AutomationVisualExport" + }, + "type" : "array", + "uniqueItems" : true + } + }, + "type" : "object" + }, + "AfmIdentifier" : { + "description" : "Reference to the attribute label to which the filter should be applied.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AfmObjectIdentifier" + }, { + "$ref" : "#/components/schemas/AfmLocalIdentifier" + } ], + "type" : "object" + }, + "AfmLocalIdentifier" : { + "properties" : { + "localIdentifier" : { + "example" : "sampleAutoGenerated0123_ID", + "pattern" : "^[.a-zA-Z0-9_-]+$", + "type" : "string" + } + }, + "required" : [ "localIdentifier" ], + "type" : "object" + }, + "AfmObjectIdentifier" : { + "description" : "ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.", + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "enum" : [ "analyticalDashboard", "attribute", "dashboardPlugin", "dataset", "fact", "label", "metric", "prompt", "visualizationObject", "filterContext" ], + "example" : "fact", + "type" : "string" } }, - "required": [ - "type", - "id" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AfmObjectIdentifierAttribute": { - "description": "Reference to the date attribute to use.", - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "enum": [ - "attribute" - ], - "type": "string" + "required" : [ "type", "id" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AfmObjectIdentifierAttribute" : { + "description" : "Reference to the date attribute to use.", + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "enum" : [ "attribute" ], + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AfmObjectIdentifierCore": { - "description": "Reference to the metric, fact or attribute object to use for the metric.", - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "enum": [ - "attribute", - "label", - "fact", - "metric" - ], - "type": "string" + "required" : [ "id", "type" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AfmObjectIdentifierCore" : { + "description" : "Reference to the metric, fact or attribute object to use for the metric.", + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "enum" : [ "attribute", "label", "fact", "metric" ], + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AfmObjectIdentifierDataset": { - "description": "Date dataset used for anomaly detection.", - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "enum": [ - "dataset" - ], - "type": "string" + "required" : [ "id", "type" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AfmObjectIdentifierDataset" : { + "description" : "Date dataset used for anomaly detection.", + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "enum" : [ "dataset" ], + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AfmObjectIdentifierLabel": { - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "enum": [ - "label" - ], - "type": "string" + "required" : [ "id", "type" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AfmObjectIdentifierLabel" : { + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "enum" : [ "label" ], + "type" : "string" } }, - "required": [ - "type", - "id" - ], - "type": "object" + "required" : [ "type", "id" ], + "type" : "object" } }, - "required": [ - "identifier" - ], - "type": "object" + "required" : [ "identifier" ], + "type" : "object" }, - "AlertAfm": { - "properties": { - "attributes": { - "description": "Attributes to be used in the computation.", - "items": { - "$ref": "#/components/schemas/AttributeItem" + "AlertAfm" : { + "properties" : { + "attributes" : { + "description" : "Attributes to be used in the computation.", + "items" : { + "$ref" : "#/components/schemas/AttributeItem" }, - "maximum": 1, - "type": "array" + "maximum" : 1, + "type" : "array" }, - "auxMeasures": { - "description": "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", - "items": { - "$ref": "#/components/schemas/MeasureItem" + "auxMeasures" : { + "description" : "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", + "items" : { + "$ref" : "#/components/schemas/MeasureItem" }, - "type": "array" + "type" : "array" }, - "filters": { - "description": "Various filter types to filter execution result. For anomaly detection, exactly one dataset is specified in the condition. The AFM may contain multiple date filters for different datasets, but only the date filter matching the dataset from the condition is used for anomaly detection.", - "items": { - "$ref": "#/components/schemas/FilterDefinition" + "filters" : { + "description" : "Various filter types to filter execution result. For anomaly detection, exactly one dataset is specified in the condition. The AFM may contain multiple date filters for different datasets, but only the date filter matching the dataset from the condition is used for anomaly detection.", + "items" : { + "$ref" : "#/components/schemas/FilterDefinition" }, - "type": "array" + "type" : "array" }, - "measures": { - "description": "Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other.", - "items": { - "$ref": "#/components/schemas/MeasureItem" + "measures" : { + "description" : "Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other.", + "items" : { + "$ref" : "#/components/schemas/MeasureItem" }, - "maximum": 2, - "minimum": 1, - "type": "array" + "maximum" : 2, + "minimum" : 1, + "type" : "array" } }, - "required": [ - "filters", - "measures" - ], - "type": "object" + "required" : [ "filters", "measures" ], + "type" : "object" + }, + "AlertCondition" : { + "description" : "Alert trigger condition.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ComparisonWrapper" + }, { + "$ref" : "#/components/schemas/RangeWrapper" + }, { + "$ref" : "#/components/schemas/RelativeWrapper" + }, { + "$ref" : "#/components/schemas/AnomalyDetectionWrapper" + } ], + "type" : "object" + }, + "AlertConditionOperand" : { + "description" : "Operand of the alert condition.", + "oneOf" : [ { + "$ref" : "#/components/schemas/LocalIdentifier" + }, { + "$ref" : "#/components/schemas/Value" + } ], + "type" : "object" }, - "AlertCondition": { - "description": "Alert trigger condition.", - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonWrapper" + "AlertDescription" : { + "properties" : { + "attribute" : { + "type" : "string" }, - { - "$ref": "#/components/schemas/RangeWrapper" + "condition" : { + "type" : "string" }, - { - "$ref": "#/components/schemas/RelativeWrapper" + "currentValues" : { + "items" : { + "$ref" : "#/components/schemas/AlertEvaluationRow" + }, + "type" : "array" }, - { - "$ref": "#/components/schemas/AnomalyDetectionWrapper" - } - ], - "type": "object" - }, - "AlertConditionOperand": { - "description": "Operand of the alert condition.", - "oneOf": [ - { - "$ref": "#/components/schemas/LocalIdentifier" + "errorMessage" : { + "type" : "string" + }, + "formattedThreshold" : { + "type" : "string" + }, + "lowerThreshold" : { + "format" : "double", + "type" : "number" + }, + "metric" : { + "type" : "string" + }, + "remainingAlertEvaluationCount" : { + "format" : "int32", + "type" : "integer" + }, + "status" : { + "enum" : [ "SUCCESS", "ERROR", "INTERNAL_ERROR", "TIMEOUT" ], + "type" : "string" + }, + "threshold" : { + "format" : "double", + "type" : "number" + }, + "totalValueCount" : { + "format" : "int32", + "type" : "integer" }, - { - "$ref": "#/components/schemas/Value" + "traceId" : { + "type" : "string" + }, + "triggeredAt" : { + "format" : "date-time", + "type" : "string" + }, + "triggeredCount" : { + "format" : "int32", + "type" : "integer" + }, + "upperThreshold" : { + "format" : "double", + "type" : "number" } - ], - "type": "object" + }, + "required" : [ "condition", "metric" ], + "type" : "object" }, - "AlertDescription": { - "properties": { - "attribute": { - "type": "string" - }, - "condition": { - "type": "string" + "AlertEvaluationRow" : { + "properties" : { + "computedMetric" : { + "$ref" : "#/components/schemas/MetricRecord" }, - "currentValues": { - "items": { - "$ref": "#/components/schemas/AlertEvaluationRow" - }, - "type": "array" + "labelValue" : { + "type" : "string" }, - "errorMessage": { - "type": "string" + "primaryMetric" : { + "$ref" : "#/components/schemas/MetricRecord" }, - "formattedThreshold": { - "type": "string" + "secondaryMetric" : { + "$ref" : "#/components/schemas/MetricRecord" + } + }, + "type" : "object" + }, + "AnomalyDetection" : { + "properties" : { + "dataset" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierDataset" }, - "lowerThreshold": { - "format": "double", - "type": "number" + "granularity" : { + "description" : "Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).", + "enum" : [ "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], + "type" : "string" }, - "metric": { - "type": "string" - }, - "remainingAlertEvaluationCount": { - "format": "int32", - "type": "integer" + "measure" : { + "$ref" : "#/components/schemas/LocalIdentifier" }, - "status": { - "enum": [ - "SUCCESS", - "ERROR", - "INTERNAL_ERROR", - "TIMEOUT" - ], - "type": "string" + "sensitivity" : { + "description" : "Sensitivity level for anomaly detection", + "enum" : [ "LOW", "MEDIUM", "HIGH" ], + "type" : "string" + } + }, + "required" : [ "dataset", "granularity", "measure", "sensitivity" ], + "type" : "object" + }, + "AnomalyDetectionWrapper" : { + "properties" : { + "anomaly" : { + "$ref" : "#/components/schemas/AnomalyDetection" + } + }, + "required" : [ "anomaly" ], + "type" : "object" + }, + "ArithmeticMeasure" : { + "properties" : { + "left" : { + "$ref" : "#/components/schemas/LocalIdentifier" }, - "threshold": { - "format": "double", - "type": "number" + "operator" : { + "description" : "Arithmetic operator.\nDIFFERENCE - m₁−m₂ - the difference between two metrics.\nCHANGE - (m₁−m₂)÷m₂ - the relative difference between two metrics.\n", + "enum" : [ "DIFFERENCE", "CHANGE" ], + "type" : "string" }, - "totalValueCount": { - "format": "int32", - "type": "integer" - }, - "traceId": { - "type": "string" - }, - "triggeredAt": { - "format": "date-time", - "type": "string" - }, - "triggeredCount": { - "format": "int32", - "type": "integer" - }, - "upperThreshold": { - "format": "double", - "type": "number" - } - }, - "required": [ - "condition", - "metric" - ], - "type": "object" - }, - "AlertEvaluationRow": { - "properties": { - "computedMetric": { - "$ref": "#/components/schemas/MetricRecord" - }, - "labelValue": { - "type": "string" - }, - "primaryMetric": { - "$ref": "#/components/schemas/MetricRecord" - }, - "secondaryMetric": { - "$ref": "#/components/schemas/MetricRecord" - } - }, - "type": "object" - }, - "AnomalyDetection": { - "properties": { - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" - }, - "granularity": { - "description": "Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).", - "enum": [ - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR" - ], - "type": "string" - }, - "measure": { - "$ref": "#/components/schemas/LocalIdentifier" - }, - "sensitivity": { - "description": "Sensitivity level for anomaly detection", - "enum": [ - "LOW", - "MEDIUM", - "HIGH" - ], - "type": "string" - } - }, - "required": [ - "dataset", - "granularity", - "measure", - "sensitivity" - ], - "type": "object" - }, - "AnomalyDetectionWrapper": { - "properties": { - "anomaly": { - "$ref": "#/components/schemas/AnomalyDetection" - } - }, - "required": [ - "anomaly" - ], - "type": "object" - }, - "ArithmeticMeasure": { - "properties": { - "left": { - "$ref": "#/components/schemas/LocalIdentifier" - }, - "operator": { - "description": "Arithmetic operator.\nDIFFERENCE - m₁−m₂ - the difference between two metrics.\nCHANGE - (m₁−m₂)÷m₂ - the relative difference between two metrics.\n", - "enum": [ - "DIFFERENCE", - "CHANGE" - ], - "type": "string" - }, - "right": { - "$ref": "#/components/schemas/LocalIdentifier" - } - }, - "required": [ - "left", - "operator", - "right" - ], - "type": "object" - }, - "ArithmeticMeasureDefinition": { - "description": "Metric representing arithmetics between other metrics.", - "properties": { - "arithmeticMeasure": { - "properties": { - "measureIdentifiers": { - "description": "List of metrics to apply arithmetic operation by chosen operator.", - "items": { - "$ref": "#/components/schemas/AfmLocalIdentifier" + "right" : { + "$ref" : "#/components/schemas/LocalIdentifier" + } + }, + "required" : [ "left", "operator", "right" ], + "type" : "object" + }, + "ArithmeticMeasureDefinition" : { + "description" : "Metric representing arithmetics between other metrics.", + "properties" : { + "arithmeticMeasure" : { + "properties" : { + "measureIdentifiers" : { + "description" : "List of metrics to apply arithmetic operation by chosen operator.", + "items" : { + "$ref" : "#/components/schemas/AfmLocalIdentifier" }, - "type": "array" - }, - "operator": { - "description": "Arithmetic operator describing operation between metrics.", - "enum": [ - "SUM", - "DIFFERENCE", - "MULTIPLICATION", - "RATIO", - "CHANGE" - ], - "example": "SUM", - "type": "string" + "type" : "array" + }, + "operator" : { + "description" : "Arithmetic operator describing operation between metrics.", + "enum" : [ "SUM", "DIFFERENCE", "MULTIPLICATION", "RATIO", "CHANGE" ], + "example" : "SUM", + "type" : "string" } }, - "required": [ - "measureIdentifiers", - "operator" - ], - "type": "object" + "required" : [ "measureIdentifiers", "operator" ], + "type" : "object" } - }, - "required": [ - "arithmeticMeasure" - ], - "type": "object" + }, + "required" : [ "arithmeticMeasure" ], + "type" : "object" + }, + "AttributeElements" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/AttributeElementsByRef" + }, { + "$ref" : "#/components/schemas/AttributeElementsByValue" + } ], + "type" : "object" + }, + "AttributeElementsByRef" : { + "properties" : { + "uris" : { + "description" : "List of attribute elements by reference", + "items" : { + "nullable" : true, + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ "uris" ], + "type" : "object" + }, + "AttributeElementsByValue" : { + "properties" : { + "values" : { + "description" : "List of attribute elements by value", + "items" : { + "nullable" : true, + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ "values" ], + "type" : "object" + }, + "AttributeFilter" : { + "description" : "Abstract filter definition type attributes", + "oneOf" : [ { + "$ref" : "#/components/schemas/NegativeAttributeFilter" + }, { + "$ref" : "#/components/schemas/PositiveAttributeFilter" + } ], + "type" : "object" }, - "AttributeElements": { - "oneOf": [ - { - "$ref": "#/components/schemas/AttributeElementsByRef" + "AttributeFilterByDate" : { + "properties" : { + "filterLocalIdentifier" : { + "type" : "string" }, - { - "$ref": "#/components/schemas/AttributeElementsByValue" + "isCommonDate" : { + "type" : "boolean" } - ], - "type": "object" - }, - "AttributeElementsByRef": { - "properties": { - "uris": { - "description": "List of attribute elements by reference", - "items": { - "nullable": true, - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "uris" - ], - "type": "object" - }, - "AttributeElementsByValue": { - "properties": { - "values": { - "description": "List of attribute elements by value", - "items": { - "nullable": true, - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "values" - ], - "type": "object" - }, - "AttributeFilter": { - "description": "Abstract filter definition type attributes", - "oneOf": [ - { - "$ref": "#/components/schemas/NegativeAttributeFilter" - }, - { - "$ref": "#/components/schemas/PositiveAttributeFilter" - } - ], - "type": "object" - }, - "AttributeFilterByDate": { - "properties": { - "filterLocalIdentifier": { - "type": "string" - }, - "isCommonDate": { - "type": "boolean" - } - }, - "required": [ - "filterLocalIdentifier", - "isCommonDate" - ], - "type": "object" - }, - "AttributeFilterElements": { - "description": "Filter on specific set of label values.", - "properties": { - "values": { - "description": "Set of label values.", - "example": [ - "value1", - "value2" - ], - "items": { - "nullable": true, - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "values" - ], - "type": "object" - }, - "AttributeFilterParent": { - "properties": { - "filterLocalIdentifier": { - "type": "string" - }, - "over": { - "$ref": "#/components/schemas/Over" - } - }, - "required": [ - "filterLocalIdentifier", - "over" - ], - "type": "object" - }, - "AttributeItem": { - "properties": { - "label": { - "$ref": "#/components/schemas/AfmObjectIdentifierLabel" - }, - "localIdentifier": { - "description": "Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.", - "example": "attribute_1", - "pattern": "^[.a-zA-Z0-9_-]+$", - "type": "string" - }, - "showAllValues": { - "default": false, - "description": "Indicates whether to show all values of given attribute even if the data bound to those values is not available.", - "type": "boolean" - } - }, - "required": [ - "label", - "localIdentifier" - ], - "type": "object" - }, - "AutomationAlert": { - "properties": { - "condition": { - "oneOf": [ - { - "$ref": "#/components/schemas/AnomalyDetectionWrapper" - }, - { - "$ref": "#/components/schemas/ComparisonWrapper" - }, - { - "$ref": "#/components/schemas/RangeWrapper" - }, - { - "$ref": "#/components/schemas/RelativeWrapper" - } - ] + }, + "required" : [ "filterLocalIdentifier", "isCommonDate" ], + "type" : "object" + }, + "AttributeFilterElements" : { + "description" : "Filter on specific set of label values.", + "properties" : { + "values" : { + "description" : "Set of label values.", + "example" : [ "value1", "value2" ], + "items" : { + "nullable" : true, + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "values" ], + "type" : "object" + }, + "AttributeFilterParent" : { + "properties" : { + "filterLocalIdentifier" : { + "type" : "string" }, - "execution": { - "$ref": "#/components/schemas/AlertAfm" + "over" : { + "$ref" : "#/components/schemas/Over" + } + }, + "required" : [ "filterLocalIdentifier", "over" ], + "type" : "object" + }, + "AttributeItem" : { + "properties" : { + "label" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierLabel" }, - "trigger": { - "default": "ALWAYS", - "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\n", - "enum": [ - "ALWAYS", - "ONCE" - ], - "type": "string" + "localIdentifier" : { + "description" : "Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.", + "example" : "attribute_1", + "pattern" : "^[.a-zA-Z0-9_-]+$", + "type" : "string" + }, + "showAllValues" : { + "default" : false, + "description" : "Indicates whether to show all values of given attribute even if the data bound to those values is not available.", + "type" : "boolean" + } + }, + "required" : [ "label", "localIdentifier" ], + "type" : "object" + }, + "AutomationAlert" : { + "properties" : { + "condition" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/AnomalyDetectionWrapper" + }, { + "$ref" : "#/components/schemas/ComparisonWrapper" + }, { + "$ref" : "#/components/schemas/RangeWrapper" + }, { + "$ref" : "#/components/schemas/RelativeWrapper" + } ] + }, + "execution" : { + "$ref" : "#/components/schemas/AlertAfm" + }, + "interval" : { + "description" : "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", + "enum" : [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], + "type" : "string" + }, + "trigger" : { + "default" : "ALWAYS", + "description" : "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", + "enum" : [ "ALWAYS", "ONCE", "ONCE_PER_INTERVAL" ], + "type" : "string" } }, - "required": [ - "condition", - "execution" - ], - "type": "object" + "required" : [ "condition", "execution" ], + "type" : "object" }, - "AutomationDashboardTabularExport": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/DashboardTabularExportRequestV2" + "AutomationDashboardTabularExport" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/DashboardTabularExportRequestV2" } }, - "required": [ - "requestPayload" - ], - "type": "object" + "required" : [ "requestPayload" ], + "type" : "object" }, - "AutomationExternalRecipient": { - "properties": { - "email": { - "description": "E-mail address to send notifications from.", - "format": "email", - "type": "string" + "AutomationExternalRecipient" : { + "properties" : { + "email" : { + "description" : "E-mail address to send notifications from.", + "format" : "email", + "type" : "string" } }, - "required": [ - "email" - ], - "type": "object" + "required" : [ "email" ], + "type" : "object" }, - "AutomationImageExport": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/ImageExportRequest" + "AutomationImageExport" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/ImageExportRequest" } }, - "required": [ - "requestPayload" - ], - "type": "object" + "required" : [ "requestPayload" ], + "type" : "object" }, - "AutomationMetadata": { - "additionalProperties": true, - "description": "Additional information for the automation.", - "maxLength": 250000, - "nullable": true, - "properties": { - "visibleFilters": { - "items": { - "$ref": "#/components/schemas/VisibleFilter" + "AutomationMetadata" : { + "description" : "Additional information for the automation.", + "maxLength" : 250000, + "nullable" : true, + "properties" : { + "visibleFilters" : { + "items" : { + "$ref" : "#/components/schemas/VisibleFilter" }, - "type": "array" + "type" : "array" }, - "widget": { - "type": "string" + "widget" : { + "type" : "string" } }, - "type": "object" + "type" : "object" }, - "AutomationNotification": { - "allOf": [ - { - "$ref": "#/components/schemas/NotificationContent" + "AutomationNotification" : { + "allOf" : [ { + "$ref" : "#/components/schemas/NotificationContent" + }, { + "properties" : { + "content" : { + "$ref" : "#/components/schemas/WebhookMessage" + } }, - { - "properties": { - "content": { - "$ref": "#/components/schemas/WebhookMessage" - } - }, - "type": "object" - } - ], - "required": [ - "content" - ], - "type": "object" - }, - "AutomationRawExport": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/RawExportAutomationRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "AutomationSlidesExport": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/SlidesExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "AutomationTabularExport": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/TabularExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "AutomationVisualExport": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/VisualExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "BoundedFilter": { - "description": "Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range.", - "properties": { - "from": { - "description": "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). If null, then start of the range is unbounded.", - "example": -6, - "format": "int32", - "nullable": true, - "type": "integer" - }, - "granularity": { - "description": "Date granularity specifying particular date attribute in given dimension.", - "enum": [ - "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", - "MINUTE_OF_HOUR", - "HOUR_OF_DAY", - "DAY_OF_WEEK", - "DAY_OF_MONTH", - "DAY_OF_QUARTER", - "DAY_OF_YEAR", - "WEEK_OF_YEAR", - "MONTH_OF_YEAR", - "QUARTER_OF_YEAR", - "FISCAL_MONTH", - "FISCAL_QUARTER", - "FISCAL_YEAR" - ], - "example": "DAY", - "type": "string" - }, - "to": { - "description": "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.", - "example": 0, - "format": "int32", - "nullable": true, - "type": "integer" - } - }, - "required": [ - "granularity" - ], - "type": "object" - }, - "Comparison": { - "properties": { - "left": { - "$ref": "#/components/schemas/LocalIdentifier" - }, - "operator": { - "enum": [ - "GREATER_THAN", - "GREATER_THAN_OR_EQUAL_TO", - "LESS_THAN", - "LESS_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO" - ], - "type": "string" - }, - "right": { - "$ref": "#/components/schemas/AlertConditionOperand" - } - }, - "required": [ - "left", - "operator", - "right" - ], - "type": "object" - }, - "ComparisonCondition": { - "description": "Condition that compares the metric value to a given constant value using a comparison operator.", - "properties": { - "comparison": { - "properties": { - "operator": { - "enum": [ - "GREATER_THAN", - "GREATER_THAN_OR_EQUAL_TO", - "LESS_THAN", - "LESS_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO" - ], - "example": "GREATER_THAN", - "type": "string" - }, - "value": { - "example": 100, - "type": "number" + "type" : "object" + } ], + "required" : [ "content" ], + "type" : "object" + }, + "AutomationRawExport" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/RawExportAutomationRequest" + } + }, + "required" : [ "requestPayload" ], + "type" : "object" + }, + "AutomationSlidesExport" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/SlidesExportRequest" + } + }, + "required" : [ "requestPayload" ], + "type" : "object" + }, + "AutomationTabularExport" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/TabularExportRequest" + } + }, + "required" : [ "requestPayload" ], + "type" : "object" + }, + "AutomationVisualExport" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/VisualExportRequest" + } + }, + "required" : [ "requestPayload" ], + "type" : "object" + }, + "BoundedFilter" : { + "description" : "Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range.", + "properties" : { + "from" : { + "description" : "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). If null, then start of the range is unbounded.", + "example" : -6, + "format" : "int32", + "nullable" : true, + "type" : "integer" + }, + "granularity" : { + "description" : "Date granularity specifying particular date attribute in given dimension.", + "enum" : [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], + "example" : "DAY", + "type" : "string" + }, + "to" : { + "description" : "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.", + "example" : 0, + "format" : "int32", + "nullable" : true, + "type" : "integer" + } + }, + "required" : [ "granularity" ], + "type" : "object" + }, + "Comparison" : { + "properties" : { + "left" : { + "$ref" : "#/components/schemas/LocalIdentifier" + }, + "operator" : { + "enum" : [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ], + "type" : "string" + }, + "right" : { + "$ref" : "#/components/schemas/AlertConditionOperand" + } + }, + "required" : [ "left", "operator", "right" ], + "type" : "object" + }, + "ComparisonCondition" : { + "description" : "Condition that compares the metric value to a given constant value using a comparison operator.", + "properties" : { + "comparison" : { + "properties" : { + "operator" : { + "enum" : [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ], + "example" : "GREATER_THAN", + "type" : "string" + }, + "value" : { + "example" : 100, + "type" : "number" } }, - "required": [ - "operator", - "value" - ], - "type": "object" - } - }, - "required": [ - "comparison" - ], - "type": "object" - }, - "ComparisonMeasureValueFilter": { - "description": "Filter the result by comparing specified metric to given constant value, using given comparison operator.", - "properties": { - "comparisonMeasureValueFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" + "required" : [ "operator", "value" ], + "type" : "object" + } + }, + "required" : [ "comparison" ], + "type" : "object" + }, + "ComparisonMeasureValueFilter" : { + "description" : "Filter the result by comparing specified metric to given constant value, using given comparison operator.", + "properties" : { + "comparisonMeasureValueFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "dimensionality" : { + "description" : "References to the attributes to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "type": "array" - }, - "localIdentifier": { - "type": "string" - }, - "measure": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "operator": { - "enum": [ - "GREATER_THAN", - "GREATER_THAN_OR_EQUAL_TO", - "LESS_THAN", - "LESS_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO" - ], - "example": "GREATER_THAN", - "type": "string" - }, - "treatNullValuesAs": { - "description": "A value that will be substituted for null values in the metric for the comparisons.", - "example": 0, - "type": "number" - }, - "value": { - "example": 1327, - "type": "number" + "type" : "array" + }, + "localIdentifier" : { + "type" : "string" + }, + "measure" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "operator" : { + "enum" : [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ], + "example" : "GREATER_THAN", + "type" : "string" + }, + "treatNullValuesAs" : { + "description" : "A value that will be substituted for null values in the metric for the comparisons.", + "example" : 0, + "type" : "number" + }, + "value" : { + "example" : 1327, + "type" : "number" } }, - "required": [ - "operator", - "value", - "measure" - ], - "type": "object" - } - }, - "required": [ - "comparisonMeasureValueFilter" - ], - "type": "object" - }, - "ComparisonWrapper": { - "properties": { - "comparison": { - "$ref": "#/components/schemas/Comparison" - } - }, - "required": [ - "comparison" - ], - "type": "object" - }, - "CompoundMeasureValueFilter": { - "description": "Filter the result by applying multiple comparison and/or range conditions combined with OR logic. If conditions list is empty, no filtering is applied (all rows are returned).", - "properties": { - "compoundMeasureValueFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "conditions": { - "description": "List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned.", - "items": { - "$ref": "#/components/schemas/MeasureValueCondition" + "required" : [ "operator", "value", "measure" ], + "type" : "object" + } + }, + "required" : [ "comparisonMeasureValueFilter" ], + "type" : "object" + }, + "ComparisonWrapper" : { + "properties" : { + "comparison" : { + "$ref" : "#/components/schemas/Comparison" + } + }, + "required" : [ "comparison" ], + "type" : "object" + }, + "CompoundMeasureValueFilter" : { + "description" : "Filter the result by applying multiple comparison and/or range conditions combined with OR logic. If conditions list is empty, no filtering is applied (all rows are returned).", + "properties" : { + "compoundMeasureValueFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "conditions" : { + "description" : "List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned.", + "items" : { + "$ref" : "#/components/schemas/MeasureValueCondition" }, - "type": "array" + "type" : "array" }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" + "dimensionality" : { + "description" : "References to the attributes to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "type": "array" + "type" : "array" }, - "localIdentifier": { - "type": "string" + "localIdentifier" : { + "type" : "string" }, - "measure": { - "$ref": "#/components/schemas/AfmIdentifier" + "measure" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "treatNullValuesAs": { - "description": "A value that will be substituted for null values in the metric for the comparisons.", - "example": 0, - "type": "number" + "treatNullValuesAs" : { + "description" : "A value that will be substituted for null values in the metric for the comparisons.", + "example" : 0, + "type" : "number" } }, - "required": [ - "conditions", - "measure" - ], - "type": "object" + "required" : [ "conditions", "measure" ], + "type" : "object" } }, - "required": [ - "compoundMeasureValueFilter" - ], - "type": "object" + "required" : [ "compoundMeasureValueFilter" ], + "type" : "object" }, - "CustomLabel": { - "description": "Custom label object override.", - "properties": { - "title": { - "description": "Override value.", - "type": "string" + "CustomLabel" : { + "description" : "Custom label object override.", + "properties" : { + "title" : { + "description" : "Override value.", + "type" : "string" } }, - "required": [ - "title" - ], - "type": "object" + "required" : [ "title" ], + "type" : "object" }, - "CustomMetric": { - "description": "Custom metric object override.", - "properties": { - "format": { - "description": "Format override.", - "type": "string" + "CustomMetric" : { + "description" : "Custom metric object override.", + "properties" : { + "format" : { + "description" : "Format override.", + "type" : "string" }, - "title": { - "description": "Metric title override.", - "type": "string" + "title" : { + "description" : "Metric title override.", + "type" : "string" } }, - "required": [ - "format", - "title" - ], - "type": "object" + "required" : [ "format", "title" ], + "type" : "object" }, - "CustomOverride": { - "description": "Custom cell value overrides (IDs will be replaced with specified values).", - "properties": { - "labels": { - "additionalProperties": { - "$ref": "#/components/schemas/CustomLabel" + "CustomOverride" : { + "description" : "Custom cell value overrides (IDs will be replaced with specified values).", + "properties" : { + "labels" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/CustomLabel" }, - "description": "Map of CustomLabels with keys used as placeholders in document.", - "type": "object" + "description" : "Map of CustomLabels with keys used as placeholders in document.", + "type" : "object" }, - "metrics": { - "additionalProperties": { - "$ref": "#/components/schemas/CustomMetric" + "metrics" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/CustomMetric" }, - "description": "Map of CustomMetrics with keys used as placeholders in document.", - "type": "object" + "description" : "Map of CustomMetrics with keys used as placeholders in document.", + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "DashboardAttributeFilter": { - "properties": { - "attributeFilter": { - "properties": { - "attributeElements": { - "$ref": "#/components/schemas/AttributeElements" + "DashboardAttributeFilter" : { + "properties" : { + "attributeFilter" : { + "properties" : { + "attributeElements" : { + "$ref" : "#/components/schemas/AttributeElements" }, - "displayForm": { - "$ref": "#/components/schemas/IdentifierRef" + "displayForm" : { + "$ref" : "#/components/schemas/IdentifierRef" }, - "filterElementsBy": { - "items": { - "$ref": "#/components/schemas/AttributeFilterParent" + "filterElementsBy" : { + "items" : { + "$ref" : "#/components/schemas/AttributeFilterParent" }, - "type": "array" + "type" : "array" }, - "filterElementsByDate": { - "items": { - "$ref": "#/components/schemas/AttributeFilterByDate" + "filterElementsByDate" : { + "items" : { + "$ref" : "#/components/schemas/AttributeFilterByDate" }, - "type": "array" + "type" : "array" }, - "localIdentifier": { - "type": "string" + "localIdentifier" : { + "type" : "string" }, - "negativeSelection": { - "type": "boolean" + "negativeSelection" : { + "type" : "boolean" }, - "selectionMode": { - "enum": [ - "single", - "multi" - ], - "type": "string" + "selectionMode" : { + "enum" : [ "single", "multi" ], + "type" : "string" }, - "title": { - "type": "string" + "title" : { + "type" : "string" }, - "validateElementsBy": { - "items": { - "$ref": "#/components/schemas/IdentifierRef" + "validateElementsBy" : { + "items" : { + "$ref" : "#/components/schemas/IdentifierRef" }, - "type": "array" + "type" : "array" } }, - "required": [ - "attributeElements", - "displayForm", - "negativeSelection" - ], - "type": "object" + "required" : [ "attributeElements", "displayForm", "negativeSelection" ], + "type" : "object" } }, - "required": [ - "attributeFilter" - ], - "type": "object" + "required" : [ "attributeFilter" ], + "type" : "object" }, - "DashboardDateFilter": { - "properties": { - "dateFilter": { - "properties": { - "attribute": { - "$ref": "#/components/schemas/IdentifierRef" + "DashboardDateFilter" : { + "properties" : { + "dateFilter" : { + "properties" : { + "attribute" : { + "$ref" : "#/components/schemas/IdentifierRef" }, - "boundedFilter": { - "$ref": "#/components/schemas/RelativeBoundedDateFilter" + "boundedFilter" : { + "$ref" : "#/components/schemas/RelativeBoundedDateFilter" }, - "dataSet": { - "$ref": "#/components/schemas/IdentifierRef" + "dataSet" : { + "$ref" : "#/components/schemas/IdentifierRef" }, - "from": { - "oneOf": [ - { - "type": "string" - }, - { - "format": "int32", - "type": "integer" - } - ] - }, - "granularity": { - "enum": [ - "ALL_TIME_GRANULARITY", - "GDC.time.year", - "GDC.time.week_us", - "GDC.time.week_in_year", - "GDC.time.week_in_quarter", - "GDC.time.week", - "GDC.time.euweek_in_year", - "GDC.time.euweek_in_quarter", - "GDC.time.quarter", - "GDC.time.quarter_in_year", - "GDC.time.month", - "GDC.time.month_in_quarter", - "GDC.time.month_in_year", - "GDC.time.day_in_year", - "GDC.time.day_in_quarter", - "GDC.time.day_in_month", - "GDC.time.day_in_week", - "GDC.time.day_in_euweek", - "GDC.time.date", - "GDC.time.hour", - "GDC.time.hour_in_day", - "GDC.time.minute", - "GDC.time.minute_in_hour", - "GDC.time.fiscal_month", - "GDC.time.fiscal_quarter", - "GDC.time.fiscal_year" - ], - "type": "string" - }, - "includeEmptyValues": { - "type": "boolean" - }, - "localIdentifier": { - "type": "string" - }, - "to": { - "oneOf": [ - { - "type": "string" - }, - { - "format": "int32", - "type": "integer" - } - ] - }, - "type": { - "enum": [ - "relative", - "absolute" - ], - "type": "string" - } - }, - "required": [ - "granularity", - "type" - ], - "type": "object" - } - }, - "required": [ - "dateFilter" - ], - "type": "object" - }, - "DashboardExportSettings": { - "description": "Additional settings.", - "properties": { - "exportInfo": { - "default": false, - "description": "If true, the export will contain the information about the export – exported date, dashboard filters, etc.", - "example": true, - "type": "boolean" - }, - "mergeHeaders": { - "default": false, - "description": "Merge equal headers in neighbouring cells. Used for [XLSX] format only.", - "example": true, - "type": "boolean" - }, - "pageOrientation": { - "default": "PORTRAIT", - "description": "Set page orientation. (PDF)", - "enum": [ - "PORTRAIT", - "LANDSCAPE" - ], - "type": "string" - }, - "pageSize": { - "default": "A4", - "description": "Set page size. (PDF)", - "enum": [ - "A3", - "A4", - "LETTER" - ], - "type": "string" - } - }, - "type": "object" - }, - "DashboardFilter": { - "oneOf": [ - { - "$ref": "#/components/schemas/DashboardAttributeFilter" - }, - { - "$ref": "#/components/schemas/DashboardDateFilter" - } - ], - "type": "object" - }, - "DashboardTabularExportRequestV2": { - "description": "Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId).", - "properties": { - "dashboardFiltersOverride": { - "description": "List of filters that will be used instead of the default dashboard filters.", - "items": { - "$ref": "#/components/schemas/DashboardFilter" - }, - "type": "array" - }, - "dashboardId": { - "description": "Dashboard identifier", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - "type": "string" - }, - "dashboardTabsFiltersOverrides": { - "additionalProperties": { - "items": { - "$ref": "#/components/schemas/DashboardFilter" - }, - "type": "array" - }, - "description": "Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.", - "type": "object" - }, - "fileName": { - "description": "Filename of downloaded file without extension.", - "example": "result", - "type": "string" - }, - "format": { - "description": "Requested tabular export type.", - "enum": [ - "XLSX", - "PDF" - ], - "example": "XLSX", - "type": "string" - }, - "settings": { - "$ref": "#/components/schemas/DashboardExportSettings" - }, - "widgetIds": { - "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", - "items": { - "type": "string" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "dashboardId", - "fileName", - "format" - ], - "type": "object" - }, - "DateFilter": { - "description": "Abstract filter definition type for dates.", - "oneOf": [ - { - "$ref": "#/components/schemas/AbsoluteDateFilter" - }, - { - "$ref": "#/components/schemas/RelativeDateFilter" - } - ], - "type": "object" - }, - "DateValue": { - "properties": { - "value": { - "type": "string" - } - }, - "required": [ - "value" - ], - "type": "object" - }, - "DeclarativeAnalyticalDashboardIdentifier": { - "description": "An analytical dashboard identifier.", - "properties": { - "id": { - "description": "Identifier of the analytical dashboard.", - "example": "dashboard123", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "A type.", - "enum": [ - "analyticalDashboard" - ], - "example": "analyticalDashboard", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "DeclarativeNotificationChannelIdentifier": { - "description": "A notification channel identifier.", - "properties": { - "id": { - "description": "Notification channel identifier.", - "example": "webhook123", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "A type.", - "enum": [ - "notificationChannel" - ], - "example": "notificationChannel", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "DeclarativeUserIdentifier": { - "description": "A user identifier.", - "properties": { - "id": { - "description": "User identifier.", - "example": "employee123", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "A type.", - "enum": [ - "user" - ], - "example": "user", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "DefaultSmtp": { - "description": "Default SMTP destination for notifications.", - "properties": { - "fromEmail": { - "default": "no-reply@gooddata.com", - "description": "E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.", - "format": "email", - "type": "string" - }, - "fromEmailName": { - "default": "GoodData", - "description": "An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.", - "type": "string" - }, - "type": { - "description": "The destination type.", - "enum": [ - "DEFAULT_SMTP" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "ExecutionSettings": { - "description": "Various settings affecting the process of AFM execution or its result", - "properties": { - "dataSamplingPercentage": { - "description": "Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.", - "exclusiveMaximum": true, - "exclusiveMinimum": true, - "format": "float", - "maximum": 100, - "minimum": 0, - "type": "number" - }, - "timestamp": { - "description": "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "ExportResult": { - "properties": { - "errorMessage": { - "type": "string" - }, - "expiresAt": { - "format": "date-time", - "type": "string" - }, - "exportId": { - "type": "string" - }, - "fileName": { - "type": "string" - }, - "fileSize": { - "format": "int64", - "type": "integer" - }, - "fileUri": { - "type": "string" - }, - "status": { - "enum": [ - "SUCCESS", - "ERROR", - "INTERNAL_ERROR", - "TIMEOUT" - ], - "type": "string" - }, - "traceId": { - "type": "string" - }, - "triggeredAt": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "exportId", - "fileName", - "status" - ], - "type": "object" - }, - "FilterDefinition": { - "description": "Abstract filter definition type", - "oneOf": [ - { - "$ref": "#/components/schemas/InlineFilterDefinition" - }, - { - "$ref": "#/components/schemas/RankingFilter" - }, - { - "$ref": "#/components/schemas/ComparisonMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/RangeMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/CompoundMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/AbsoluteDateFilter" - }, - { - "$ref": "#/components/schemas/RelativeDateFilter" - }, - { - "$ref": "#/components/schemas/NegativeAttributeFilter" - }, - { - "$ref": "#/components/schemas/PositiveAttributeFilter" - } - ], - "type": "object" - }, - "FilterDefinitionForSimpleMeasure": { - "description": "Abstract filter definition type for simple metric.", - "oneOf": [ - { - "$ref": "#/components/schemas/DateFilter" - }, - { - "$ref": "#/components/schemas/AttributeFilter" - } - ], - "type": "object" - }, - "IdentifierRef": { - "properties": { - "identifier": { - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "analyticalDashboard", - "attribute", - "attributeHierarchy", - "dashboardPlugin", - "dataset", - "fact", - "aggregatedFact", - "label", - "metric", - "userDataFilter", - "exportDefinition", - "automation", - "automationResult", - "memoryItem", - "knowledgeRecommendation", - "prompt", - "visualizationObject", - "filterContext", - "workspaceSettings", - "customApplicationSetting", - "workspaceDataFilter", - "workspaceDataFilterSetting", - "filterView" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "type": "object" - }, - "ImageExportRequest": { - "description": "Export request object describing the export properties and metadata for image exports.", - "properties": { - "dashboardId": { - "description": "Dashboard identifier", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - "type": "string" - }, - "fileName": { - "description": "File name to be used for retrieving the image document.", - "example": "filename", - "type": "string" - }, - "format": { - "description": "Requested resulting file type.", - "enum": [ - "PNG" - ], - "example": "PNG", - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/JsonNode" - }, - "widgetIds": { - "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "dashboardId", - "fileName", - "format", - "widgetIds" - ], - "type": "object" - }, - "InPlatform": { - "description": "In-platform destination for notifications.", - "properties": { - "type": { - "description": "The destination type.", - "enum": [ - "IN_PLATFORM" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "InlineFilterDefinition": { - "description": "Filter in form of direct MAQL query.", - "properties": { - "inline": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "filter": { - "description": "MAQL query representing the filter.", - "type": "string" - }, - "localIdentifier": { - "type": "string" + "from" : { + "oneOf" : [ { + "type" : "string" + }, { + "format" : "int32", + "type" : "integer" + } ] + }, + "granularity" : { + "enum" : [ "ALL_TIME_GRANULARITY", "GDC.time.year", "GDC.time.week_us", "GDC.time.week_in_year", "GDC.time.week_in_quarter", "GDC.time.week", "GDC.time.euweek_in_year", "GDC.time.euweek_in_quarter", "GDC.time.quarter", "GDC.time.quarter_in_year", "GDC.time.month", "GDC.time.month_in_quarter", "GDC.time.month_in_year", "GDC.time.day_in_year", "GDC.time.day_in_quarter", "GDC.time.day_in_month", "GDC.time.day_in_week", "GDC.time.day_in_euweek", "GDC.time.date", "GDC.time.hour", "GDC.time.hour_in_day", "GDC.time.minute", "GDC.time.minute_in_hour", "GDC.time.fiscal_month", "GDC.time.fiscal_quarter", "GDC.time.fiscal_year" ], + "type" : "string" + }, + "localIdentifier" : { + "type" : "string" + }, + "to" : { + "oneOf" : [ { + "type" : "string" + }, { + "format" : "int32", + "type" : "integer" + } ] + }, + "type" : { + "enum" : [ "relative", "absolute" ], + "type" : "string" } }, - "required": [ - "filter" - ], - "type": "object" - } - }, - "required": [ - "inline" - ], - "type": "object" - }, - "InlineMeasureDefinition": { - "description": "Metric defined by the raw MAQL query.", - "properties": { - "inline": { - "properties": { - "maql": { - "description": "MAQL query defining the metric.", - "type": "string" + "required" : [ "granularity", "type" ], + "type" : "object" + } + }, + "required" : [ "dateFilter" ], + "type" : "object" + }, + "DashboardExportSettings" : { + "description" : "Additional settings.", + "properties" : { + "exportInfo" : { + "default" : false, + "description" : "If true, the export will contain the information about the export – exported date, dashboard filters, etc.", + "example" : true, + "type" : "boolean" + }, + "mergeHeaders" : { + "default" : false, + "description" : "Merge equal headers in neighbouring cells. Used for [XLSX] format only.", + "example" : true, + "type" : "boolean" + }, + "pageOrientation" : { + "default" : "PORTRAIT", + "description" : "Set page orientation. (PDF)", + "enum" : [ "PORTRAIT", "LANDSCAPE" ], + "type" : "string" + }, + "pageSize" : { + "default" : "A4", + "description" : "Set page size. (PDF)", + "enum" : [ "A3", "A4", "LETTER" ], + "type" : "string" + } + }, + "type" : "object" + }, + "DashboardFilter" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/DashboardAttributeFilter" + }, { + "$ref" : "#/components/schemas/DashboardDateFilter" + } ], + "type" : "object" + }, + "DashboardTabularExportRequestV2" : { + "description" : "Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId).", + "properties" : { + "dashboardFiltersOverride" : { + "description" : "List of filters that will be used instead of the default dashboard filters.", + "items" : { + "$ref" : "#/components/schemas/DashboardFilter" + }, + "type" : "array" + }, + "dashboardId" : { + "description" : "Dashboard identifier", + "example" : "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type" : "string" + }, + "dashboardTabsFiltersOverrides" : { + "additionalProperties" : { + "items" : { + "$ref" : "#/components/schemas/DashboardFilter" + }, + "type" : "array" + }, + "description" : "Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.", + "type" : "object" + }, + "fileName" : { + "description" : "Filename of downloaded file without extension.", + "example" : "result", + "type" : "string" + }, + "format" : { + "description" : "Requested tabular export type.", + "enum" : [ "XLSX", "PDF" ], + "example" : "XLSX", + "type" : "string" + }, + "settings" : { + "$ref" : "#/components/schemas/DashboardExportSettings" + }, + "widgetIds" : { + "description" : "List of widget identifiers to be exported. Note that only one widget is currently supported.", + "items" : { + "type" : "string" + }, + "maxItems" : 1, + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "dashboardId", "fileName", "format" ], + "type" : "object" + }, + "DateFilter" : { + "description" : "Abstract filter definition type for dates.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AbsoluteDateFilter" + }, { + "$ref" : "#/components/schemas/RelativeDateFilter" + } ], + "type" : "object" + }, + "DateValue" : { + "properties" : { + "value" : { + "type" : "string" + } + }, + "required" : [ "value" ], + "type" : "object" + }, + "DeclarativeAnalyticalDashboardIdentifier" : { + "description" : "An analytical dashboard identifier.", + "properties" : { + "id" : { + "description" : "Identifier of the analytical dashboard.", + "example" : "dashboard123", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "A type.", + "enum" : [ "analyticalDashboard" ], + "example" : "analyticalDashboard", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "DeclarativeNotificationChannelIdentifier" : { + "description" : "A notification channel identifier.", + "properties" : { + "id" : { + "description" : "Notification channel identifier.", + "example" : "webhook123", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "A type.", + "enum" : [ "notificationChannel" ], + "example" : "notificationChannel", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "DeclarativeUserIdentifier" : { + "description" : "A user identifier.", + "properties" : { + "id" : { + "description" : "User identifier.", + "example" : "employee123", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "A type.", + "enum" : [ "user" ], + "example" : "user", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "DefaultSmtp" : { + "description" : "Default SMTP destination for notifications.", + "properties" : { + "fromEmail" : { + "default" : "no-reply@gooddata.com", + "description" : "E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.", + "format" : "email", + "type" : "string" + }, + "fromEmailName" : { + "default" : "GoodData", + "description" : "An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.", + "type" : "string" + }, + "type" : { + "description" : "The destination type.", + "enum" : [ "DEFAULT_SMTP" ], + "type" : "string" + } + }, + "required" : [ "type" ], + "type" : "object" + }, + "ExecutionSettings" : { + "description" : "Various settings affecting the process of AFM execution or its result", + "properties" : { + "dataSamplingPercentage" : { + "description" : "Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.", + "exclusiveMaximum" : true, + "exclusiveMinimum" : true, + "format" : "float", + "maximum" : 100, + "minimum" : 0, + "type" : "number" + }, + "timestamp" : { + "description" : "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.", + "format" : "date-time", + "type" : "string" + } + }, + "type" : "object" + }, + "ExportResult" : { + "properties" : { + "errorMessage" : { + "type" : "string" + }, + "expiresAt" : { + "format" : "date-time", + "type" : "string" + }, + "exportId" : { + "type" : "string" + }, + "fileName" : { + "type" : "string" + }, + "fileSize" : { + "format" : "int64", + "type" : "integer" + }, + "fileUri" : { + "type" : "string" + }, + "status" : { + "enum" : [ "SUCCESS", "ERROR", "INTERNAL_ERROR", "TIMEOUT" ], + "type" : "string" + }, + "traceId" : { + "type" : "string" + }, + "triggeredAt" : { + "format" : "date-time", + "type" : "string" + } + }, + "required" : [ "exportId", "fileName", "status" ], + "type" : "object" + }, + "FilterDefinition" : { + "description" : "Abstract filter definition type", + "oneOf" : [ { + "$ref" : "#/components/schemas/InlineFilterDefinition" + }, { + "$ref" : "#/components/schemas/RankingFilter" + }, { + "$ref" : "#/components/schemas/ComparisonMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/RangeMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/CompoundMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/AbsoluteDateFilter" + }, { + "$ref" : "#/components/schemas/RelativeDateFilter" + }, { + "$ref" : "#/components/schemas/NegativeAttributeFilter" + }, { + "$ref" : "#/components/schemas/PositiveAttributeFilter" + } ], + "type" : "object" + }, + "FilterDefinitionForSimpleMeasure" : { + "description" : "Abstract filter definition type for simple metric.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DateFilter" + }, { + "$ref" : "#/components/schemas/AttributeFilter" + } ], + "type" : "object" + }, + "IdentifierRef" : { + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "analyticalDashboard", "attribute", "attributeHierarchy", "dashboardPlugin", "dataset", "fact", "aggregatedFact", "label", "metric", "userDataFilter", "exportDefinition", "automation", "automationResult", "memoryItem", "knowledgeRecommendation", "prompt", "visualizationObject", "filterContext", "workspaceSettings", "customApplicationSetting", "workspaceDataFilter", "workspaceDataFilterSetting", "filterView" ], + "type" : "string" } }, - "required": [ - "maql" - ], - "type": "object" - } - }, - "required": [ - "inline" - ], - "type": "object" - }, - "JsonNode": { - "description": "Metadata definition in free-form JSON format.", - "example": {}, - "maxLength": 15000, - "nullable": true, - "type": "object" - }, - "LocalIdentifier": { - "properties": { - "format": { - "default": "#,##0.00", - "description": "Metric format.", - "example": "#,##0", - "maxLength": 2048, - "nullable": true, - "type": "string" - }, - "localIdentifier": { - "description": "Local identifier of the metric to be compared.", - "example": "m1", - "type": "string" - }, - "title": { - "description": "Metric title.", - "example": "Revenue", - "maxLength": 255, - "nullable": true, - "type": "string" - } - }, - "required": [ - "localIdentifier" - ], - "type": "object" - }, - "MeasureDefinition": { - "description": "Abstract metric definition type", - "oneOf": [ - { - "$ref": "#/components/schemas/InlineMeasureDefinition" - }, - { - "$ref": "#/components/schemas/ArithmeticMeasureDefinition" - }, - { - "$ref": "#/components/schemas/SimpleMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopMeasureDefinition" - } - ], - "type": "object" - }, - "MeasureItem": { - "description": "Metric is a quantity that is calculated from the data.", - "properties": { - "definition": { - "oneOf": [ - { - "$ref": "#/components/schemas/ArithmeticMeasureDefinition" - }, - { - "$ref": "#/components/schemas/InlineMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopDatasetMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopDateMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopMeasureDefinition" - }, - { - "$ref": "#/components/schemas/SimpleMeasureDefinition" - } - ] - }, - "localIdentifier": { - "description": "Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.", - "example": "metric_1", - "pattern": "^[.a-zA-Z0-9_-]+$", - "type": "string" + "required" : [ "id", "type" ], + "type" : "object" } }, - "required": [ - "definition", - "localIdentifier" - ], - "type": "object" + "type" : "object" }, - "MeasureValueCondition": { - "description": "A condition for filtering by measure value. Can be either a comparison or a range condition.", - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonCondition" + "ImageExportRequest" : { + "description" : "Export request object describing the export properties and metadata for image exports.", + "properties" : { + "dashboardId" : { + "description" : "Dashboard identifier", + "example" : "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type" : "string" }, - { - "$ref": "#/components/schemas/RangeCondition" - } - ], - "type": "object" - }, - "MeasureValueFilter": { - "description": "Abstract filter definition type filtering by the value of the metric.", - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonMeasureValueFilter" + "fileName" : { + "description" : "File name to be used for retrieving the image document.", + "example" : "filename", + "type" : "string" + }, + "format" : { + "description" : "Requested resulting file type.", + "enum" : [ "PNG" ], + "example" : "PNG", + "type" : "string" }, - { - "$ref": "#/components/schemas/RangeMeasureValueFilter" + "metadata" : { + "$ref" : "#/components/schemas/JsonNode" }, - { - "$ref": "#/components/schemas/CompoundMeasureValueFilter" + "widgetIds" : { + "description" : "List of widget identifiers to be exported. Note that only one widget is currently supported.", + "items" : { + "maxLength" : 255, + "minLength" : 1, + "type" : "string" + }, + "maxItems" : 1, + "minItems" : 1, + "type" : "array", + "uniqueItems" : true } - ], - "type": "object" + }, + "required" : [ "dashboardId", "fileName", "format", "widgetIds" ], + "type" : "object" }, - "MetricRecord": { - "properties": { - "formattedValue": { - "type": "string" - }, - "value": { - "format": "double", - "type": "number" + "InPlatform" : { + "description" : "In-platform destination for notifications.", + "properties" : { + "type" : { + "description" : "The destination type.", + "enum" : [ "IN_PLATFORM" ], + "type" : "string" } }, - "required": [ - "value" - ], - "type": "object" + "required" : [ "type" ], + "type" : "object" }, - "NegativeAttributeFilter": { - "description": "Filter able to limit element values by label and related selected negated elements.", - "properties": { - "negativeAttributeFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" + "InlineFilterDefinition" : { + "description" : "Filter in form of direct MAQL query.", + "properties" : { + "inline" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" }, - "label": { - "$ref": "#/components/schemas/AfmIdentifier" + "filter" : { + "description" : "MAQL query representing the filter.", + "type" : "string" }, - "localIdentifier": { - "type": "string" - }, - "notIn": { - "$ref": "#/components/schemas/AttributeFilterElements" + "localIdentifier" : { + "type" : "string" } }, - "required": [ - "notIn", - "label" - ], - "type": "object" + "required" : [ "filter" ], + "type" : "object" } }, - "required": [ - "negativeAttributeFilter" - ], - "type": "object" + "required" : [ "inline" ], + "type" : "object" }, - "Notification": { - "properties": { - "automationId": { - "type": "string" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "data": { - "oneOf": [ - { - "$ref": "#/components/schemas/AutomationNotification" - }, - { - "$ref": "#/components/schemas/TestNotification" + "InlineMeasureDefinition" : { + "description" : "Metric defined by the raw MAQL query.", + "properties" : { + "inline" : { + "properties" : { + "maql" : { + "description" : "MAQL query defining the metric.", + "type" : "string" } - ] - }, - "id": { - "type": "string" - }, - "isRead": { - "type": "boolean" - }, - "workspaceId": { - "type": "string" + }, + "required" : [ "maql" ], + "type" : "object" + } + }, + "required" : [ "inline" ], + "type" : "object" + }, + "JsonNode" : { + "description" : "Metadata definition in free-form JSON format.", + "example" : { }, + "maxLength" : 15000, + "nullable" : true, + "type" : "object" + }, + "LocalIdentifier" : { + "properties" : { + "format" : { + "default" : "#,##0.00", + "description" : "Metric format.", + "example" : "#,##0", + "maxLength" : 2048, + "nullable" : true, + "type" : "string" + }, + "localIdentifier" : { + "description" : "Local identifier of the metric to be compared.", + "example" : "m1", + "type" : "string" + }, + "title" : { + "description" : "Metric title.", + "example" : "Revenue", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + } + }, + "required" : [ "localIdentifier" ], + "type" : "object" + }, + "MeasureDefinition" : { + "description" : "Abstract metric definition type", + "oneOf" : [ { + "$ref" : "#/components/schemas/InlineMeasureDefinition" + }, { + "$ref" : "#/components/schemas/ArithmeticMeasureDefinition" + }, { + "$ref" : "#/components/schemas/SimpleMeasureDefinition" + }, { + "$ref" : "#/components/schemas/PopMeasureDefinition" + } ], + "type" : "object" + }, + "MeasureItem" : { + "description" : "Metric is a quantity that is calculated from the data.", + "properties" : { + "definition" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/ArithmeticMeasureDefinition" + }, { + "$ref" : "#/components/schemas/InlineMeasureDefinition" + }, { + "$ref" : "#/components/schemas/PopDatasetMeasureDefinition" + }, { + "$ref" : "#/components/schemas/PopDateMeasureDefinition" + }, { + "$ref" : "#/components/schemas/PopMeasureDefinition" + }, { + "$ref" : "#/components/schemas/SimpleMeasureDefinition" + } ] + }, + "localIdentifier" : { + "description" : "Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.", + "example" : "metric_1", + "pattern" : "^[.a-zA-Z0-9_-]+$", + "type" : "string" + } + }, + "required" : [ "definition", "localIdentifier" ], + "type" : "object" + }, + "MeasureValueCondition" : { + "description" : "A condition for filtering by measure value. Can be either a comparison or a range condition.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ComparisonCondition" + }, { + "$ref" : "#/components/schemas/RangeCondition" + } ], + "type" : "object" + }, + "MeasureValueFilter" : { + "description" : "Abstract filter definition type filtering by the value of the metric.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ComparisonMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/RangeMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/CompoundMeasureValueFilter" + } ], + "type" : "object" + }, + "MetricRecord" : { + "properties" : { + "formattedValue" : { + "type" : "string" + }, + "value" : { + "format" : "double", + "type" : "number" + } + }, + "required" : [ "value" ], + "type" : "object" + }, + "NegativeAttributeFilter" : { + "description" : "Filter able to limit element values by label and related selected negated elements.", + "properties" : { + "negativeAttributeFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "label" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "localIdentifier" : { + "type" : "string" + }, + "notIn" : { + "$ref" : "#/components/schemas/AttributeFilterElements" + } + }, + "required" : [ "notIn", "label" ], + "type" : "object" } }, - "required": [ - "createdAt", - "data", - "id", - "isRead" - ], - "type": "object" + "required" : [ "negativeAttributeFilter" ], + "type" : "object" }, - "NotificationChannelDestination": { - "oneOf": [ - { - "$ref": "#/components/schemas/Webhook" + "Notification" : { + "properties" : { + "automationId" : { + "type" : "string" + }, + "createdAt" : { + "format" : "date-time", + "type" : "string" + }, + "data" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/AutomationNotification" + }, { + "$ref" : "#/components/schemas/TestNotification" + } ] }, - { - "$ref": "#/components/schemas/Smtp" + "id" : { + "type" : "string" }, - { - "$ref": "#/components/schemas/DefaultSmtp" + "isRead" : { + "type" : "boolean" }, - { - "$ref": "#/components/schemas/InPlatform" + "workspaceId" : { + "type" : "string" } - ], - "properties": { - "type": { - "type": "string" + }, + "required" : [ "createdAt", "data", "id", "isRead" ], + "type" : "object" + }, + "NotificationChannelDestination" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/Webhook" + }, { + "$ref" : "#/components/schemas/Smtp" + }, { + "$ref" : "#/components/schemas/DefaultSmtp" + }, { + "$ref" : "#/components/schemas/InPlatform" + } ], + "properties" : { + "type" : { + "type" : "string" } }, - "required": [ - "type" - ], - "type": "object" + "required" : [ "type" ], + "type" : "object" }, - "NotificationContent": { - "discriminator": { - "mapping": { - "AUTOMATION": "#/components/schemas/AutomationNotification", - "TEST": "#/components/schemas/TestNotification" + "NotificationContent" : { + "discriminator" : { + "mapping" : { + "AUTOMATION" : "#/components/schemas/AutomationNotification", + "TEST" : "#/components/schemas/TestNotification" }, - "propertyName": "type" + "propertyName" : "type" }, - "properties": { - "type": { - "type": "string" + "properties" : { + "type" : { + "type" : "string" } }, - "required": [ - "type" - ], - "type": "object" + "required" : [ "type" ], + "type" : "object" }, - "NotificationFilter": { - "properties": { - "filter": { - "type": "string" + "NotificationFilter" : { + "properties" : { + "filter" : { + "type" : "string" }, - "title": { - "type": "string" + "title" : { + "type" : "string" } }, - "required": [ - "filter", - "title" - ], - "type": "object" + "required" : [ "filter", "title" ], + "type" : "object" }, - "Notifications": { - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/Notification" + "Notifications" : { + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/Notification" }, - "type": "array" + "type" : "array" }, - "meta": { - "$ref": "#/components/schemas/NotificationsMeta" + "meta" : { + "$ref" : "#/components/schemas/NotificationsMeta" } }, - "required": [ - "data", - "meta" - ], - "type": "object" + "required" : [ "data", "meta" ], + "type" : "object" }, - "NotificationsMeta": { - "properties": { - "total": { - "$ref": "#/components/schemas/NotificationsMetaTotal" + "NotificationsMeta" : { + "properties" : { + "total" : { + "$ref" : "#/components/schemas/NotificationsMetaTotal" } }, - "type": "object" + "type" : "object" }, - "NotificationsMetaTotal": { - "properties": { - "all": { - "format": "int64", - "type": "integer" + "NotificationsMetaTotal" : { + "properties" : { + "all" : { + "format" : "int64", + "type" : "integer" }, - "unread": { - "format": "int64", - "type": "integer" + "unread" : { + "format" : "int64", + "type" : "integer" } }, - "required": [ - "all", - "unread" - ], - "type": "object" + "required" : [ "all", "unread" ], + "type" : "object" }, - "Over": { - "properties": { - "attributes": { - "items": { - "$ref": "#/components/schemas/IdentifierRef" + "Over" : { + "properties" : { + "attributes" : { + "items" : { + "$ref" : "#/components/schemas/IdentifierRef" }, - "type": "array" + "type" : "array" } }, - "required": [ - "attributes" - ], - "type": "object" + "required" : [ "attributes" ], + "type" : "object" }, - "PdfTableStyle": { - "deprecated": true, - "description": "Custom CSS styles for the table. (PDF, HTML)", - "example": [ - { - "properties": [ - { - "key": "font-size", - "value": "30px" - } - ], - "selector": "th" - } - ], - "properties": { - "properties": { - "description": "List of CSS properties.", - "items": { - "$ref": "#/components/schemas/PdfTableStyleProperty" - }, - "type": "array" - }, - "selector": { - "description": "CSS selector where to apply given properties.", - "type": "string" - } - }, - "required": [ - "selector" - ], - "type": "object" - }, - "PdfTableStyleProperty": { - "description": "CSS property.", - "properties": { - "key": { - "description": "CSS property key.", - "type": "string" - }, - "value": { - "description": "CSS property value.", - "type": "string" - } - }, - "required": [ - "key", - "value" - ], - "type": "object" - }, - "PopDataset": { - "description": "Combination of the date data set to use and how many periods ago to calculate the previous period for.", - "properties": { - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" - }, - "periodsAgo": { - "description": "Number of periods ago to calculate the previous period for.", - "example": 1, - "format": "int32", - "type": "integer" - } - }, - "required": [ - "dataset", - "periodsAgo" - ], - "type": "object" - }, - "PopDatasetMeasureDefinition": { - "description": "Previous period type of metric.", - "properties": { - "previousPeriodMeasure": { - "properties": { - "dateDatasets": { - "description": "Specification of which date data sets to use for determining the period to calculate the previous period for.", - "items": { - "$ref": "#/components/schemas/PopDataset" + "PdfTableStyle" : { + "deprecated" : true, + "description" : "Custom CSS styles for the table. (PDF, HTML)", + "example" : [ { + "properties" : [ { + "key" : "font-size", + "value" : "30px" + } ], + "selector" : "th" + } ], + "properties" : { + "properties" : { + "description" : "List of CSS properties.", + "items" : { + "$ref" : "#/components/schemas/PdfTableStyleProperty" + }, + "type" : "array" + }, + "selector" : { + "description" : "CSS selector where to apply given properties.", + "type" : "string" + } + }, + "required" : [ "selector" ], + "type" : "object" + }, + "PdfTableStyleProperty" : { + "description" : "CSS property.", + "properties" : { + "key" : { + "description" : "CSS property key.", + "type" : "string" + }, + "value" : { + "description" : "CSS property value.", + "type" : "string" + } + }, + "required" : [ "key", "value" ], + "type" : "object" + }, + "PopDataset" : { + "description" : "Combination of the date data set to use and how many periods ago to calculate the previous period for.", + "properties" : { + "dataset" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierDataset" + }, + "periodsAgo" : { + "description" : "Number of periods ago to calculate the previous period for.", + "example" : 1, + "format" : "int32", + "type" : "integer" + } + }, + "required" : [ "dataset", "periodsAgo" ], + "type" : "object" + }, + "PopDatasetMeasureDefinition" : { + "description" : "Previous period type of metric.", + "properties" : { + "previousPeriodMeasure" : { + "properties" : { + "dateDatasets" : { + "description" : "Specification of which date data sets to use for determining the period to calculate the previous period for.", + "items" : { + "$ref" : "#/components/schemas/PopDataset" }, - "type": "array" + "type" : "array" }, - "measureIdentifier": { - "$ref": "#/components/schemas/AfmLocalIdentifier" + "measureIdentifier" : { + "$ref" : "#/components/schemas/AfmLocalIdentifier" } }, - "required": [ - "dateDatasets", - "measureIdentifier" - ], - "type": "object" - } - }, - "required": [ - "previousPeriodMeasure" - ], - "type": "object" - }, - "PopDate": { - "description": "Combination of the date attribute to use and how many periods ago to calculate the PoP for.", - "properties": { - "attribute": { - "$ref": "#/components/schemas/AfmObjectIdentifierAttribute" - }, - "periodsAgo": { - "description": "Number of periods ago to calculate the previous period for.", - "example": 1, - "format": "int32", - "type": "integer" - } - }, - "required": [ - "attribute", - "periodsAgo" - ], - "type": "object" - }, - "PopDateMeasureDefinition": { - "description": "Period over period type of metric.", - "properties": { - "overPeriodMeasure": { - "properties": { - "dateAttributes": { - "description": "Attributes to use for determining the period to calculate the PoP for.", - "items": { - "$ref": "#/components/schemas/PopDate" + "required" : [ "dateDatasets", "measureIdentifier" ], + "type" : "object" + } + }, + "required" : [ "previousPeriodMeasure" ], + "type" : "object" + }, + "PopDate" : { + "description" : "Combination of the date attribute to use and how many periods ago to calculate the PoP for.", + "properties" : { + "attribute" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierAttribute" + }, + "periodsAgo" : { + "description" : "Number of periods ago to calculate the previous period for.", + "example" : 1, + "format" : "int32", + "type" : "integer" + } + }, + "required" : [ "attribute", "periodsAgo" ], + "type" : "object" + }, + "PopDateMeasureDefinition" : { + "description" : "Period over period type of metric.", + "properties" : { + "overPeriodMeasure" : { + "properties" : { + "dateAttributes" : { + "description" : "Attributes to use for determining the period to calculate the PoP for.", + "items" : { + "$ref" : "#/components/schemas/PopDate" }, - "type": "array" + "type" : "array" }, - "measureIdentifier": { - "$ref": "#/components/schemas/AfmLocalIdentifier" + "measureIdentifier" : { + "$ref" : "#/components/schemas/AfmLocalIdentifier" } }, - "required": [ - "dateAttributes", - "measureIdentifier" - ], - "type": "object" + "required" : [ "dateAttributes", "measureIdentifier" ], + "type" : "object" } }, - "required": [ - "overPeriodMeasure" - ], - "type": "object" + "required" : [ "overPeriodMeasure" ], + "type" : "object" }, - "PopMeasureDefinition": { - "oneOf": [ - { - "$ref": "#/components/schemas/PopDatasetMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopDateMeasureDefinition" - } - ], - "type": "object" + "PopMeasureDefinition" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/PopDatasetMeasureDefinition" + }, { + "$ref" : "#/components/schemas/PopDateMeasureDefinition" + } ], + "type" : "object" }, - "PositiveAttributeFilter": { - "description": "Filter able to limit element values by label and related selected elements.", - "properties": { - "positiveAttributeFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" + "PositiveAttributeFilter" : { + "description" : "Filter able to limit element values by label and related selected elements.", + "properties" : { + "positiveAttributeFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" }, - "in": { - "$ref": "#/components/schemas/AttributeFilterElements" + "in" : { + "$ref" : "#/components/schemas/AttributeFilterElements" }, - "label": { - "$ref": "#/components/schemas/AfmIdentifier" + "label" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "localIdentifier": { - "type": "string" + "localIdentifier" : { + "type" : "string" } }, - "required": [ - "in", - "label" - ], - "type": "object" - } - }, - "required": [ - "positiveAttributeFilter" - ], - "type": "object" - }, - "Range": { - "properties": { - "from": { - "$ref": "#/components/schemas/Value" - }, - "measure": { - "$ref": "#/components/schemas/LocalIdentifier" - }, - "operator": { - "enum": [ - "BETWEEN", - "NOT_BETWEEN" - ], - "type": "string" - }, - "to": { - "$ref": "#/components/schemas/Value" - } - }, - "required": [ - "from", - "measure", - "operator", - "to" - ], - "type": "object" - }, - "RangeCondition": { - "description": "Condition that checks if the metric value is within a given range.", - "properties": { - "range": { - "properties": { - "from": { - "example": 100, - "type": "number" - }, - "operator": { - "enum": [ - "BETWEEN", - "NOT_BETWEEN" - ], - "example": "BETWEEN", - "type": "string" - }, - "to": { - "example": 999, - "type": "number" + "required" : [ "in", "label" ], + "type" : "object" + } + }, + "required" : [ "positiveAttributeFilter" ], + "type" : "object" + }, + "Range" : { + "properties" : { + "from" : { + "$ref" : "#/components/schemas/Value" + }, + "measure" : { + "$ref" : "#/components/schemas/LocalIdentifier" + }, + "operator" : { + "enum" : [ "BETWEEN", "NOT_BETWEEN" ], + "type" : "string" + }, + "to" : { + "$ref" : "#/components/schemas/Value" + } + }, + "required" : [ "from", "measure", "operator", "to" ], + "type" : "object" + }, + "RangeCondition" : { + "description" : "Condition that checks if the metric value is within a given range.", + "properties" : { + "range" : { + "properties" : { + "from" : { + "example" : 100, + "type" : "number" + }, + "operator" : { + "enum" : [ "BETWEEN", "NOT_BETWEEN" ], + "example" : "BETWEEN", + "type" : "string" + }, + "to" : { + "example" : 999, + "type" : "number" } }, - "required": [ - "from", - "operator", - "to" - ], - "type": "object" - } - }, - "required": [ - "range" - ], - "type": "object" - }, - "RangeMeasureValueFilter": { - "description": "Filter the result by comparing specified metric to given range of values.", - "properties": { - "rangeMeasureValueFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" + "required" : [ "from", "operator", "to" ], + "type" : "object" + } + }, + "required" : [ "range" ], + "type" : "object" + }, + "RangeMeasureValueFilter" : { + "description" : "Filter the result by comparing specified metric to given range of values.", + "properties" : { + "rangeMeasureValueFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "dimensionality" : { + "description" : "References to the attributes to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "type": "array" - }, - "from": { - "example": 100, - "type": "number" - }, - "localIdentifier": { - "type": "string" - }, - "measure": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "operator": { - "enum": [ - "BETWEEN", - "NOT_BETWEEN" - ], - "example": "BETWEEN", - "type": "string" - }, - "to": { - "example": 999, - "type": "number" - }, - "treatNullValuesAs": { - "description": "A value that will be substituted for null values in the metric for the comparisons.", - "example": 0, - "type": "number" + "type" : "array" + }, + "from" : { + "example" : 100, + "type" : "number" + }, + "localIdentifier" : { + "type" : "string" + }, + "measure" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "operator" : { + "enum" : [ "BETWEEN", "NOT_BETWEEN" ], + "example" : "BETWEEN", + "type" : "string" + }, + "to" : { + "example" : 999, + "type" : "number" + }, + "treatNullValuesAs" : { + "description" : "A value that will be substituted for null values in the metric for the comparisons.", + "example" : 0, + "type" : "number" } }, - "required": [ - "from", - "operator", - "to", - "measure" - ], - "type": "object" - } - }, - "required": [ - "rangeMeasureValueFilter" - ], - "type": "object" - }, - "RangeWrapper": { - "properties": { - "range": { - "$ref": "#/components/schemas/Range" - } - }, - "required": [ - "range" - ], - "type": "object" - }, - "RankingFilter": { - "description": "Filter the result on top/bottom N values according to given metric(s).", - "properties": { - "rankingFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" + "required" : [ "from", "operator", "to", "measure" ], + "type" : "object" + } + }, + "required" : [ "rangeMeasureValueFilter" ], + "type" : "object" + }, + "RangeWrapper" : { + "properties" : { + "range" : { + "$ref" : "#/components/schemas/Range" + } + }, + "required" : [ "range" ], + "type" : "object" + }, + "RankingFilter" : { + "description" : "Filter the result on top/bottom N values according to given metric(s).", + "properties" : { + "rankingFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "dimensionality" : { + "description" : "References to the attributes to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "type": "array" + "type" : "array" }, - "localIdentifier": { - "type": "string" + "localIdentifier" : { + "type" : "string" }, - "measures": { - "description": "References to the metrics to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" + "measures" : { + "description" : "References to the metrics to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "type": "array" - }, - "operator": { - "description": "The type of ranking to use, TOP or BOTTOM.", - "enum": [ - "TOP", - "BOTTOM" - ], - "type": "string" - }, - "value": { - "description": "Number of top/bottom values to filter.", - "example": 5, - "format": "int32", - "type": "integer" + "type" : "array" + }, + "operator" : { + "description" : "The type of ranking to use, TOP or BOTTOM.", + "enum" : [ "TOP", "BOTTOM" ], + "type" : "string" + }, + "value" : { + "description" : "Number of top/bottom values to filter.", + "example" : 5, + "format" : "int32", + "type" : "integer" } }, - "required": [ - "measures", - "operator", - "value" - ], - "type": "object" - } - }, - "required": [ - "rankingFilter" - ], - "type": "object" - }, - "RawCustomLabel": { - "description": "Custom label object override.", - "properties": { - "title": { - "description": "Override value.", - "type": "string" - } - }, - "required": [ - "title" - ], - "type": "object" - }, - "RawCustomMetric": { - "description": "Custom metric object override.", - "properties": { - "title": { - "description": "Metric title override.", - "type": "string" - } - }, - "required": [ - "title" - ], - "type": "object" - }, - "RawCustomOverride": { - "description": "Custom cell value overrides (IDs will be replaced with specified values).", - "properties": { - "labels": { - "additionalProperties": { - "$ref": "#/components/schemas/RawCustomLabel" - }, - "description": "Map of CustomLabels with keys used as placeholders in export result.", - "type": "object" - }, - "metrics": { - "additionalProperties": { - "$ref": "#/components/schemas/RawCustomMetric" - }, - "description": "Map of CustomMetrics with keys used as placeholders in export result.", - "type": "object" - } - }, - "type": "object" - }, - "RawExportAutomationRequest": { - "description": "Export request object describing the export properties and overrides for raw exports.", - "properties": { - "customOverride": { - "$ref": "#/components/schemas/RawCustomOverride" - }, - "delimiter": { - "description": "Set column delimiter. (CSV)", - "maxLength": 1, - "minLength": 1, - "pattern": "^[^\\r\\n\"]$", - "type": "string" - }, - "execution": { - "$ref": "#/components/schemas/AFM" - }, - "executionSettings": { - "$ref": "#/components/schemas/ExecutionSettings" - }, - "fileName": { - "description": "Filename of downloaded file without extension.", - "example": "result", - "type": "string" - }, - "format": { - "description": "Requested resulting file type.", - "enum": [ - "ARROW_FILE", - "ARROW_STREAM", - "CSV" - ], - "example": "CSV", - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/JsonNode" - } - }, - "required": [ - "execution", - "fileName", - "format" - ], - "type": "object" - }, - "Relative": { - "properties": { - "measure": { - "$ref": "#/components/schemas/ArithmeticMeasure" - }, - "operator": { - "description": "Relative condition operator.\nINCREASES_BY - the metric increases by the specified value.\nDECREASES_BY - the metric decreases by the specified value.\nCHANGES_BY - the metric increases or decreases by the specified value.\n", - "enum": [ - "INCREASES_BY", - "DECREASES_BY", - "CHANGES_BY" - ], - "type": "string" - }, - "threshold": { - "$ref": "#/components/schemas/Value" - } - }, - "required": [ - "measure", - "operator", - "threshold" - ], - "type": "object" - }, - "RelativeBoundedDateFilter": { - "properties": { - "from": { - "format": "int32", - "type": "integer" - }, - "granularity": { - "enum": [ - "ALL_TIME_GRANULARITY", - "GDC.time.year", - "GDC.time.week_us", - "GDC.time.week_in_year", - "GDC.time.week_in_quarter", - "GDC.time.week", - "GDC.time.euweek_in_year", - "GDC.time.euweek_in_quarter", - "GDC.time.quarter", - "GDC.time.quarter_in_year", - "GDC.time.month", - "GDC.time.month_in_quarter", - "GDC.time.month_in_year", - "GDC.time.day_in_year", - "GDC.time.day_in_quarter", - "GDC.time.day_in_month", - "GDC.time.day_in_week", - "GDC.time.day_in_euweek", - "GDC.time.date", - "GDC.time.hour", - "GDC.time.hour_in_day", - "GDC.time.minute", - "GDC.time.minute_in_hour", - "GDC.time.fiscal_month", - "GDC.time.fiscal_quarter", - "GDC.time.fiscal_year" - ], - "type": "string" - }, - "to": { - "format": "int32", - "type": "integer" - } - }, - "required": [ - "granularity" - ], - "type": "object" - }, - "RelativeDateFilter": { - "description": "A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both.", - "properties": { - "relativeDateFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "boundedFilter": { - "$ref": "#/components/schemas/BoundedFilter" - }, - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" - }, - "from": { - "description": "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago').", - "example": -6, - "format": "int32", - "type": "integer" - }, - "granularity": { - "description": "Date granularity specifying particular date attribute in given dimension.", - "enum": [ - "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", - "MINUTE_OF_HOUR", - "HOUR_OF_DAY", - "DAY_OF_WEEK", - "DAY_OF_MONTH", - "DAY_OF_QUARTER", - "DAY_OF_YEAR", - "WEEK_OF_YEAR", - "MONTH_OF_YEAR", - "QUARTER_OF_YEAR", - "FISCAL_MONTH", - "FISCAL_QUARTER", - "FISCAL_YEAR" - ], - "example": "DAY", - "type": "string" - }, - "includeEmptyValues": { - "description": "If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).", - "type": "boolean" - }, - "localIdentifier": { - "type": "string" - }, - "to": { - "description": "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...).", - "example": 0, - "format": "int32", - "type": "integer" - } + "required" : [ "measures", "operator", "value" ], + "type" : "object" + } + }, + "required" : [ "rankingFilter" ], + "type" : "object" + }, + "RawCustomLabel" : { + "description" : "Custom label object override.", + "properties" : { + "title" : { + "description" : "Override value.", + "type" : "string" + } + }, + "required" : [ "title" ], + "type" : "object" + }, + "RawCustomMetric" : { + "description" : "Custom metric object override.", + "properties" : { + "title" : { + "description" : "Metric title override.", + "type" : "string" + } + }, + "required" : [ "title" ], + "type" : "object" + }, + "RawCustomOverride" : { + "description" : "Custom cell value overrides (IDs will be replaced with specified values).", + "properties" : { + "labels" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/RawCustomLabel" }, - "required": [ - "from", - "granularity", - "to", - "dataset" - ], - "type": "object" - } - }, - "required": [ - "relativeDateFilter" - ], - "type": "object" - }, - "RelativeWrapper": { - "properties": { - "relative": { - "$ref": "#/components/schemas/Relative" - } - }, - "required": [ - "relative" - ], - "type": "object" - }, - "Settings": { - "description": "Additional settings.", - "properties": { - "delimiter": { - "description": "Set column delimiter. (CSV)", - "maxLength": 1, - "minLength": 1, - "pattern": "^[^\\r\\n\"]$", - "type": "string" - }, - "exportInfo": { - "default": false, - "description": "If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF)", - "example": true, - "type": "boolean" - }, - "mergeHeaders": { - "description": "Merge equal headers in neighbouring cells. (XLSX)", - "example": true, - "type": "boolean" - }, - "pageOrientation": { - "default": "PORTRAIT", - "description": "Set page orientation. (PDF)", - "enum": [ - "PORTRAIT", - "LANDSCAPE" - ], - "type": "string" - }, - "pageSize": { - "default": "A4", - "description": "Set page size. (PDF)", - "enum": [ - "A3", - "A4", - "LETTER" - ], - "type": "string" - }, - "pdfPageSize": { - "deprecated": true, - "description": "Page size and orientation. (PDF)", - "example": "a4 landscape", - "type": "string" - }, - "pdfTableStyle": { - "deprecated": true, - "description": "Custom CSS styles for the table. (PDF, HTML)", - "example": [ - { - "properties": [ - { - "key": "font-size", - "value": "30px" - } - ], - "selector": "th" + "description" : "Map of CustomLabels with keys used as placeholders in export result.", + "type" : "object" + }, + "metrics" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/RawCustomMetric" + }, + "description" : "Map of CustomMetrics with keys used as placeholders in export result.", + "type" : "object" + } + }, + "type" : "object" + }, + "RawExportAutomationRequest" : { + "description" : "Export request object describing the export properties and overrides for raw exports.", + "properties" : { + "customOverride" : { + "$ref" : "#/components/schemas/RawCustomOverride" + }, + "delimiter" : { + "description" : "Set column delimiter. (CSV)", + "maxLength" : 1, + "minLength" : 1, + "pattern" : "^[^\\r\\n\"]$", + "type" : "string" + }, + "execution" : { + "$ref" : "#/components/schemas/AFM" + }, + "executionSettings" : { + "$ref" : "#/components/schemas/ExecutionSettings" + }, + "fileName" : { + "description" : "Filename of downloaded file without extension.", + "example" : "result", + "type" : "string" + }, + "format" : { + "description" : "Requested resulting file type.", + "enum" : [ "ARROW_FILE", "ARROW_STREAM", "CSV" ], + "example" : "CSV", + "type" : "string" + }, + "metadata" : { + "$ref" : "#/components/schemas/JsonNode" + } + }, + "required" : [ "execution", "fileName", "format" ], + "type" : "object" + }, + "Relative" : { + "properties" : { + "measure" : { + "$ref" : "#/components/schemas/ArithmeticMeasure" + }, + "operator" : { + "description" : "Relative condition operator.\nINCREASES_BY - the metric increases by the specified value.\nDECREASES_BY - the metric decreases by the specified value.\nCHANGES_BY - the metric increases or decreases by the specified value.\n", + "enum" : [ "INCREASES_BY", "DECREASES_BY", "CHANGES_BY" ], + "type" : "string" + }, + "threshold" : { + "$ref" : "#/components/schemas/Value" + } + }, + "required" : [ "measure", "operator", "threshold" ], + "type" : "object" + }, + "RelativeBoundedDateFilter" : { + "properties" : { + "from" : { + "format" : "int32", + "type" : "integer" + }, + "granularity" : { + "enum" : [ "ALL_TIME_GRANULARITY", "GDC.time.year", "GDC.time.week_us", "GDC.time.week_in_year", "GDC.time.week_in_quarter", "GDC.time.week", "GDC.time.euweek_in_year", "GDC.time.euweek_in_quarter", "GDC.time.quarter", "GDC.time.quarter_in_year", "GDC.time.month", "GDC.time.month_in_quarter", "GDC.time.month_in_year", "GDC.time.day_in_year", "GDC.time.day_in_quarter", "GDC.time.day_in_month", "GDC.time.day_in_week", "GDC.time.day_in_euweek", "GDC.time.date", "GDC.time.hour", "GDC.time.hour_in_day", "GDC.time.minute", "GDC.time.minute_in_hour", "GDC.time.fiscal_month", "GDC.time.fiscal_quarter", "GDC.time.fiscal_year" ], + "type" : "string" + }, + "to" : { + "format" : "int32", + "type" : "integer" + } + }, + "required" : [ "granularity" ], + "type" : "object" + }, + "RelativeDateFilter" : { + "description" : "A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both.", + "properties" : { + "relativeDateFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "boundedFilter" : { + "$ref" : "#/components/schemas/BoundedFilter" + }, + "dataset" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierDataset" + }, + "from" : { + "description" : "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago').", + "example" : -6, + "format" : "int32", + "type" : "integer" + }, + "granularity" : { + "description" : "Date granularity specifying particular date attribute in given dimension.", + "enum" : [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], + "example" : "DAY", + "type" : "string" + }, + "localIdentifier" : { + "type" : "string" + }, + "to" : { + "description" : "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...).", + "example" : 0, + "format" : "int32", + "type" : "integer" } - ], - "items": { - "$ref": "#/components/schemas/PdfTableStyle" - }, - "type": "array" - }, - "pdfTopLeftContent": { - "deprecated": true, - "description": "Top left header content. (PDF)", - "example": "Good", - "type": "string" - }, - "pdfTopRightContent": { - "deprecated": true, - "description": "Top right header content. (PDF)", - "example": "Morning", - "type": "string" - }, - "showFilters": { - "deprecated": true, - "description": "Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)", - "example": false, - "type": "boolean" - } - }, - "type": "object" - }, - "SimpleMeasureDefinition": { - "description": "Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.", - "properties": { - "measure": { - "properties": { - "aggregation": { - "description": "Definition of aggregation type of the metric.", - "enum": [ - "SUM", - "COUNT", - "AVG", - "MIN", - "MAX", - "MEDIAN", - "RUNSUM", - "APPROXIMATE_COUNT" - ], - "example": "SUM", - "type": "string" - }, - "computeRatio": { - "default": false, - "description": "If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).", - "example": true, - "type": "boolean" - }, - "filters": { - "description": "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.", - "items": { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" + }, + "required" : [ "from", "granularity", "to", "dataset" ], + "type" : "object" + } + }, + "required" : [ "relativeDateFilter" ], + "type" : "object" + }, + "RelativeWrapper" : { + "properties" : { + "relative" : { + "$ref" : "#/components/schemas/Relative" + } + }, + "required" : [ "relative" ], + "type" : "object" + }, + "Settings" : { + "description" : "Additional settings.", + "properties" : { + "delimiter" : { + "description" : "Set column delimiter. (CSV)", + "maxLength" : 1, + "minLength" : 1, + "pattern" : "^[^\\r\\n\"]$", + "type" : "string" + }, + "exportInfo" : { + "default" : false, + "description" : "If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF)", + "example" : true, + "type" : "boolean" + }, + "mergeHeaders" : { + "description" : "Merge equal headers in neighbouring cells. (XLSX)", + "example" : true, + "type" : "boolean" + }, + "pageOrientation" : { + "default" : "PORTRAIT", + "description" : "Set page orientation. (PDF)", + "enum" : [ "PORTRAIT", "LANDSCAPE" ], + "type" : "string" + }, + "pageSize" : { + "default" : "A4", + "description" : "Set page size. (PDF)", + "enum" : [ "A3", "A4", "LETTER" ], + "type" : "string" + }, + "pdfPageSize" : { + "deprecated" : true, + "description" : "Page size and orientation. (PDF)", + "example" : "a4 landscape", + "type" : "string" + }, + "pdfTableStyle" : { + "deprecated" : true, + "description" : "Custom CSS styles for the table. (PDF, HTML)", + "example" : [ { + "properties" : [ { + "key" : "font-size", + "value" : "30px" + } ], + "selector" : "th" + } ], + "items" : { + "$ref" : "#/components/schemas/PdfTableStyle" + }, + "type" : "array" + }, + "pdfTopLeftContent" : { + "deprecated" : true, + "description" : "Top left header content. (PDF)", + "example" : "Good", + "type" : "string" + }, + "pdfTopRightContent" : { + "deprecated" : true, + "description" : "Top right header content. (PDF)", + "example" : "Morning", + "type" : "string" + }, + "showFilters" : { + "deprecated" : true, + "description" : "Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)", + "example" : false, + "type" : "boolean" + } + }, + "type" : "object" + }, + "SimpleMeasureDefinition" : { + "description" : "Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.", + "properties" : { + "measure" : { + "properties" : { + "aggregation" : { + "description" : "Definition of aggregation type of the metric.", + "enum" : [ "SUM", "COUNT", "AVG", "MIN", "MAX", "MEDIAN", "RUNSUM", "APPROXIMATE_COUNT" ], + "example" : "SUM", + "type" : "string" + }, + "computeRatio" : { + "default" : false, + "description" : "If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).", + "example" : true, + "type" : "boolean" + }, + "filters" : { + "description" : "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.", + "items" : { + "$ref" : "#/components/schemas/FilterDefinitionForSimpleMeasure" }, - "type": "array" + "type" : "array" }, - "item": { - "$ref": "#/components/schemas/AfmObjectIdentifierCore" + "item" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierCore" } }, - "required": [ - "item" - ], - "type": "object" - } - }, - "required": [ - "measure" - ], - "type": "object" - }, - "SlidesExportRequest": { - "description": "Export request object describing the export properties and metadata for slides exports.", - "properties": { - "dashboardId": { - "description": "Dashboard identifier", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - "type": "string" - }, - "fileName": { - "description": "File name to be used for retrieving the pdf document.", - "example": "filename", - "type": "string" - }, - "format": { - "description": "Requested resulting file type.", - "enum": [ - "PDF", - "PPTX" - ], - "example": "PDF", - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/JsonNode" - }, - "templateId": { - "description": "Export template identifier.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "visualizationIds": { - "description": "List of visualization ids to be exported. Note that only one visualization is currently supported.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true - }, - "widgetIds": { - "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "fileName", - "format" - ], - "type": "object" - }, - "Smtp": { - "description": "Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update", - "properties": { - "fromEmail": { - "default": "no-reply@gooddata.com", - "description": "E-mail address to send notifications from.", - "format": "email", - "type": "string" - }, - "fromEmailName": { - "default": "GoodData", - "description": "An optional e-mail name to send notifications from.", - "type": "string" - }, - "host": { - "description": "The SMTP server address.", - "type": "string" - }, - "password": { - "description": "The SMTP server password.", - "type": "string", - "writeOnly": true - }, - "port": { - "description": "The SMTP server port.", - "enum": [ - 25, - 465, - 587, - 2525 - ], - "format": "int32", - "type": "integer" - }, - "type": { - "description": "The destination type.", - "enum": [ - "SMTP" - ], - "type": "string" - }, - "username": { - "description": "The SMTP server username.", - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "TabularExportRequest": { - "description": "Export request object describing the export properties and overrides for tabular exports.", - "properties": { - "customOverride": { - "$ref": "#/components/schemas/CustomOverride" - }, - "executionResult": { - "description": "Execution result identifier.", - "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", - "type": "string" - }, - "fileName": { - "description": "Filename of downloaded file without extension.", - "example": "result", - "type": "string" - }, - "format": { - "description": "Expected file format.", - "enum": [ - "CSV", - "XLSX", - "HTML", - "PDF" - ], - "example": "CSV", - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/JsonNode" - }, - "relatedDashboardId": { - "description": "Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - "type": "string" - }, - "settings": { - "$ref": "#/components/schemas/Settings" - }, - "visualizationObject": { - "description": "Visualization object identifier. Alternative to executionResult property.", - "example": "f7c359bc-c230-4487-b15b-ad9685bcb537", - "type": "string" - }, - "visualizationObjectCustomFilters": { - "description": "Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.", - "example": "[{\"negativeAttributeFilter\":{\"displayForm\":{\"identifier\":{\"id\":\"products.category\",\"type\":\"label\"}},\"notIn\":{\"values\":[\"Books\"]}}}]", - "items": { - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "fileName", - "format" - ], - "type": "object" - }, - "TestDestinationRequest": { - "description": "Request body with notification channel destination to test.", - "properties": { - "destination": { - "oneOf": [ - { - "$ref": "#/components/schemas/DefaultSmtp" - }, - { - "$ref": "#/components/schemas/InPlatform" - }, - { - "$ref": "#/components/schemas/Smtp" - }, - { - "$ref": "#/components/schemas/Webhook" - } - ] + "required" : [ "item" ], + "type" : "object" + } + }, + "required" : [ "measure" ], + "type" : "object" + }, + "SlidesExportRequest" : { + "description" : "Export request object describing the export properties and metadata for slides exports.", + "properties" : { + "dashboardId" : { + "description" : "Dashboard identifier", + "example" : "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type" : "string" + }, + "fileName" : { + "description" : "File name to be used for retrieving the pdf document.", + "example" : "filename", + "type" : "string" + }, + "format" : { + "description" : "Requested resulting file type.", + "enum" : [ "PDF", "PPTX" ], + "example" : "PDF", + "type" : "string" + }, + "metadata" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "templateId" : { + "description" : "Export template identifier.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "visualizationIds" : { + "description" : "List of visualization ids to be exported. Note that only one visualization is currently supported.", + "items" : { + "maxLength" : 255, + "minLength" : 1, + "type" : "string" + }, + "maxItems" : 1, + "type" : "array", + "uniqueItems" : true + }, + "widgetIds" : { + "description" : "List of widget identifiers to be exported. Note that only one widget is currently supported.", + "items" : { + "maxLength" : 255, + "minLength" : 1, + "type" : "string" + }, + "maxItems" : 1, + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "fileName", "format" ], + "type" : "object" + }, + "Smtp" : { + "description" : "Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update", + "properties" : { + "fromEmail" : { + "default" : "no-reply@gooddata.com", + "description" : "E-mail address to send notifications from.", + "format" : "email", + "type" : "string" + }, + "fromEmailName" : { + "default" : "GoodData", + "description" : "An optional e-mail name to send notifications from.", + "type" : "string" + }, + "host" : { + "description" : "The SMTP server address.", + "type" : "string" + }, + "password" : { + "description" : "The SMTP server password.", + "type" : "string", + "writeOnly" : true + }, + "port" : { + "description" : "The SMTP server port.", + "enum" : [ 25, 465, 587, 2525 ], + "format" : "int32", + "type" : "integer" + }, + "type" : { + "description" : "The destination type.", + "enum" : [ "SMTP" ], + "type" : "string" + }, + "username" : { + "description" : "The SMTP server username.", + "type" : "string" + } + }, + "required" : [ "type" ], + "type" : "object" + }, + "TabularExportRequest" : { + "description" : "Export request object describing the export properties and overrides for tabular exports.", + "properties" : { + "customOverride" : { + "$ref" : "#/components/schemas/CustomOverride" + }, + "executionResult" : { + "description" : "Execution result identifier.", + "example" : "ff483727196c9dc862c7fd3a5a84df55c96d61a4", + "type" : "string" + }, + "fileName" : { + "description" : "Filename of downloaded file without extension.", + "example" : "result", + "type" : "string" + }, + "format" : { + "description" : "Expected file format.", + "enum" : [ "CSV", "XLSX", "HTML", "PDF" ], + "example" : "CSV", + "type" : "string" + }, + "metadata" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "relatedDashboardId" : { + "description" : "Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.", + "example" : "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type" : "string" + }, + "settings" : { + "$ref" : "#/components/schemas/Settings" + }, + "visualizationObject" : { + "description" : "Visualization object identifier. Alternative to executionResult property.", + "example" : "f7c359bc-c230-4487-b15b-ad9685bcb537", + "type" : "string" + }, + "visualizationObjectCustomFilters" : { + "description" : "Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.", + "example" : "[{\"negativeAttributeFilter\":{\"displayForm\":{\"identifier\":{\"id\":\"products.category\",\"type\":\"label\"}},\"notIn\":{\"values\":[\"Books\"]}}}]", + "items" : { + "type" : "object" + }, + "type" : "array" + } + }, + "required" : [ "fileName", "format" ], + "type" : "object" + }, + "TestDestinationRequest" : { + "description" : "Request body with notification channel destination to test.", + "properties" : { + "destination" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultSmtp" + }, { + "$ref" : "#/components/schemas/InPlatform" + }, { + "$ref" : "#/components/schemas/Smtp" + }, { + "$ref" : "#/components/schemas/Webhook" + } ] + }, + "externalRecipients" : { + "description" : "External recipients of the test result.", + "items" : { + "$ref" : "#/components/schemas/AutomationExternalRecipient" + }, + "maxItems" : 1, + "nullable" : true, + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "destination" ], + "type" : "object" + }, + "TestNotification" : { + "allOf" : [ { + "$ref" : "#/components/schemas/NotificationContent" + }, { + "properties" : { + "message" : { + "type" : "string" + } }, - "externalRecipients": { - "description": "External recipients of the test result.", - "items": { - "$ref": "#/components/schemas/AutomationExternalRecipient" - }, - "maxItems": 1, - "nullable": true, - "type": "array", - "uniqueItems": true + "type" : "object" + } ], + "required" : [ "message" ], + "type" : "object" + }, + "TestResponse" : { + "description" : "Response from notification channel testing.", + "properties" : { + "error" : { + "description" : "Field containing more details in case of a failure. Details are available to a privileged user only.", + "example" : "Authentication failed", + "type" : "string" + }, + "successful" : { + "description" : "A flag indicating whether test passed or not.", + "example" : true, + "type" : "boolean" + } + }, + "required" : [ "successful" ], + "type" : "object" + }, + "TriggerAutomationRequest" : { + "properties" : { + "automation" : { + "$ref" : "#/components/schemas/AdHocAutomation" + } + }, + "required" : [ "automation" ], + "type" : "object" + }, + "Value" : { + "properties" : { + "value" : { + "description" : "Value of the alert threshold to compare the metric to.", + "example" : 1000, + "type" : "number" + } + }, + "required" : [ "value" ], + "type" : "object" + }, + "VisibleFilter" : { + "properties" : { + "isAllTimeDateFilter" : { + "default" : false, + "description" : "Indicates if the filter is an all-time date filter. Such a filter is not included in report computation, so there is no filter with the same 'localIdentifier' to be found. In such cases, this flag is used to inform the server to not search for the filter in the definitions and include it anyways.", + "type" : "boolean" + }, + "localIdentifier" : { + "type" : "string" + }, + "title" : { + "type" : "string" + } + }, + "type" : "object" + }, + "VisualExportRequest" : { + "description" : "Export request object describing the export properties and metadata for dashboard PDF exports.", + "properties" : { + "dashboardId" : { + "description" : "Dashboard identifier", + "example" : "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type" : "string" + }, + "fileName" : { + "description" : "File name to be used for retrieving the pdf document.", + "example" : "filename", + "type" : "string" + }, + "metadata" : { + "description" : "Metadata definition in free-form JSON format.", + "example" : "{}", + "type" : "object" } }, - "required": [ - "destination" - ], - "type": "object" + "required" : [ "dashboardId", "fileName" ], + "type" : "object" }, - "TestNotification": { - "allOf": [ - { - "$ref": "#/components/schemas/NotificationContent" + "Webhook" : { + "description" : "Webhook destination for notifications. The property url is required on create and update.", + "properties" : { + "hasSecretKey" : { + "description" : "Flag indicating if webhook has a hmac secret key.", + "maxLength" : 10000, + "nullable" : true, + "readOnly" : true, + "type" : "boolean" }, - { - "properties": { - "message": { - "type": "string" - } - }, - "type": "object" - } - ], - "required": [ - "message" - ], - "type": "object" - }, - "TestResponse": { - "description": "Response from notification channel testing.", - "properties": { - "error": { - "description": "Field containing more details in case of a failure. Details are available to a privileged user only.", - "example": "Authentication failed", - "type": "string" - }, - "successful": { - "description": "A flag indicating whether test passed or not.", - "example": true, - "type": "boolean" - } - }, - "required": [ - "successful" - ], - "type": "object" - }, - "TriggerAutomationRequest": { - "properties": { - "automation": { - "$ref": "#/components/schemas/AdHocAutomation" - } - }, - "required": [ - "automation" - ], - "type": "object" - }, - "Value": { - "properties": { - "value": { - "description": "Value of the alert threshold to compare the metric to.", - "example": 1000, - "type": "number" - } - }, - "required": [ - "value" - ], - "type": "object" - }, - "VisibleFilter": { - "properties": { - "isAllTimeDateFilter": { - "default": false, - "description": "Indicates if the filter is an all-time date filter. Such a filter is not included in report computation, so there is no filter with the same 'localIdentifier' to be found. In such cases, this flag is used to inform the server to not search for the filter in the definitions and include it anyways.", - "type": "boolean" - }, - "localIdentifier": { - "type": "string" - }, - "title": { - "type": "string" - } - }, - "type": "object" - }, - "VisualExportRequest": { - "description": "Export request object describing the export properties and metadata for dashboard PDF exports.", - "properties": { - "dashboardId": { - "description": "Dashboard identifier", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - "type": "string" - }, - "fileName": { - "description": "File name to be used for retrieving the pdf document.", - "example": "filename", - "type": "string" - }, - "metadata": { - "description": "Metadata definition in free-form JSON format.", - "example": "{}", - "type": "object" - } - }, - "required": [ - "dashboardId", - "fileName" - ], - "type": "object" - }, - "Webhook": { - "description": "Webhook destination for notifications. The property url is required on create and update.", - "properties": { - "hasSecretKey": { - "description": "Flag indicating if webhook has a hmac secret key.", - "maxLength": 10000, - "nullable": true, - "readOnly": true, - "type": "boolean" - }, - "hasToken": { - "description": "Flag indicating if webhook has a token.", - "maxLength": 10000, - "nullable": true, - "readOnly": true, - "type": "boolean" - }, - "secretKey": { - "description": "Hmac secret key for the webhook signature.", - "example": "secret_key", - "maxLength": 10000, - "nullable": true, - "type": "string", - "writeOnly": true - }, - "token": { - "description": "Bearer token for the webhook.", - "example": "secret", - "maxLength": 10000, - "nullable": true, - "type": "string", - "writeOnly": true - }, - "type": { - "description": "The destination type.", - "enum": [ - "WEBHOOK" - ], - "type": "string" - }, - "url": { - "description": "The webhook URL.", - "example": "https://webhook.site/something", - "maxLength": 255, - "pattern": "https?\\://.*", - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "WebhookAutomationInfo": { - "properties": { - "dashboardTitle": { - "type": "string" - }, - "dashboardURL": { - "type": "string" - }, - "id": { - "type": "string" - }, - "isCustomDashboardURL": { - "type": "boolean" - }, - "title": { - "type": "string" - } + "hasToken" : { + "description" : "Flag indicating if webhook has a token.", + "maxLength" : 10000, + "nullable" : true, + "readOnly" : true, + "type" : "boolean" + }, + "secretKey" : { + "description" : "Hmac secret key for the webhook signature.", + "example" : "secret_key", + "maxLength" : 10000, + "nullable" : true, + "type" : "string", + "writeOnly" : true + }, + "token" : { + "description" : "Bearer token for the webhook.", + "example" : "secret", + "maxLength" : 10000, + "nullable" : true, + "type" : "string", + "writeOnly" : true + }, + "type" : { + "description" : "The destination type.", + "enum" : [ "WEBHOOK" ], + "type" : "string" + }, + "url" : { + "description" : "The webhook URL.", + "example" : "https://webhook.site/something", + "maxLength" : 255, + "pattern" : "https?\\://.*", + "type" : "string" + } + }, + "required" : [ "type" ], + "type" : "object" + }, + "WebhookAutomationInfo" : { + "properties" : { + "dashboardTitle" : { + "type" : "string" + }, + "dashboardURL" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "isCustomDashboardURL" : { + "type" : "boolean" + }, + "title" : { + "type" : "string" + } }, - "required": [ - "dashboardURL", - "id", - "isCustomDashboardURL" - ], - "type": "object" - }, - "WebhookMessage": { - "properties": { - "data": { - "$ref": "#/components/schemas/WebhookMessageData" + "required" : [ "dashboardURL", "id", "isCustomDashboardURL" ], + "type" : "object" + }, + "WebhookMessage" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/WebhookMessageData" }, - "timestamp": { - "format": "date-time", - "type": "string" + "timestamp" : { + "format" : "date-time", + "type" : "string" }, - "type": { - "enum": [ - "automation-task.completed", - "automation-task.limit-exceeded" - ], - "type": "string" + "type" : { + "enum" : [ "automation-task.completed", "automation-task.limit-exceeded" ], + "type" : "string" } - }, - "required": [ - "data", - "timestamp", - "type" - ], - "type": "object" + }, + "required" : [ "data", "timestamp", "type" ], + "type" : "object" }, - "WebhookMessageData": { - "properties": { - "alert": { - "$ref": "#/components/schemas/AlertDescription" + "WebhookMessageData" : { + "properties" : { + "alert" : { + "$ref" : "#/components/schemas/AlertDescription" }, - "automation": { - "$ref": "#/components/schemas/WebhookAutomationInfo" + "automation" : { + "$ref" : "#/components/schemas/WebhookAutomationInfo" }, - "dashboardTabularExports": { - "items": { - "$ref": "#/components/schemas/ExportResult" + "dashboardTabularExports" : { + "items" : { + "$ref" : "#/components/schemas/ExportResult" }, - "type": "array" + "type" : "array" }, - "details": { - "additionalProperties": { - "type": "string" + "details" : { + "additionalProperties" : { + "type" : "string" }, - "type": "object" + "type" : "object" }, - "filters": { - "items": { - "$ref": "#/components/schemas/NotificationFilter" + "filters" : { + "items" : { + "$ref" : "#/components/schemas/NotificationFilter" }, - "type": "array" + "type" : "array" }, - "imageExports": { - "items": { - "$ref": "#/components/schemas/ExportResult" + "imageExports" : { + "items" : { + "$ref" : "#/components/schemas/ExportResult" }, - "type": "array" + "type" : "array" }, - "notificationSource": { - "type": "string" + "notificationSource" : { + "type" : "string" }, - "rawExports": { - "items": { - "$ref": "#/components/schemas/ExportResult" + "rawExports" : { + "items" : { + "$ref" : "#/components/schemas/ExportResult" }, - "type": "array" + "type" : "array" }, - "recipients": { - "items": { - "$ref": "#/components/schemas/WebhookRecipient" + "recipients" : { + "items" : { + "$ref" : "#/components/schemas/WebhookRecipient" }, - "type": "array" + "type" : "array" }, - "remainingActionCount": { - "format": "int32", - "type": "integer" + "remainingActionCount" : { + "format" : "int32", + "type" : "integer" }, - "slidesExports": { - "items": { - "$ref": "#/components/schemas/ExportResult" + "slidesExports" : { + "items" : { + "$ref" : "#/components/schemas/ExportResult" }, - "type": "array" + "type" : "array" }, - "tabularExports": { - "items": { - "$ref": "#/components/schemas/ExportResult" + "tabularExports" : { + "items" : { + "$ref" : "#/components/schemas/ExportResult" }, - "type": "array" + "type" : "array" }, - "visualExports": { - "items": { - "$ref": "#/components/schemas/ExportResult" + "visualExports" : { + "items" : { + "$ref" : "#/components/schemas/ExportResult" }, - "type": "array" + "type" : "array" } }, - "required": [ - "automation" - ], - "type": "object" + "required" : [ "automation" ], + "type" : "object" }, - "WebhookRecipient": { - "properties": { - "email": { - "type": "string" + "WebhookRecipient" : { + "properties" : { + "email" : { + "type" : "string" }, - "id": { - "type": "string" + "id" : { + "type" : "string" } }, - "required": [ - "email", - "id" - ], - "type": "object" + "required" : [ "email", "id" ], + "type" : "object" } } }, - "info": { - "title": "OpenAPI definition", - "version": "v0" + "info" : { + "title" : "OpenAPI definition", + "version" : "v0" }, - "openapi": "3.0.1", - "paths": { - "/api/v1/actions/notificationChannels/test": { - "post": { - "description": "Tests the notification channel by sending a test notification.", - "operationId": "testNotificationChannel", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestDestinationRequest" + "openapi" : "3.0.1", + "paths" : { + "/api/v1/actions/notificationChannels/test" : { + "post" : { + "description" : "Tests the notification channel by sending a test notification.", + "operationId" : "testNotificationChannel", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TestDestinationRequest" } } }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "examples": { - "An example of a successful connection": { - "description": "An example of a successful connection", - "value": { - "successful": true + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "An example of a successful connection" : { + "description" : "An example of a successful connection", + "value" : { + "successful" : true } }, - "An example of an unsuccessful connection": { - "description": "An example of an unsuccessful connection", - "value": { - "error": "Authentication failed", - "successful": false + "An example of an unsuccessful connection" : { + "description" : "An example of an unsuccessful connection", + "value" : { + "error" : "Authentication failed", + "successful" : false } } }, - "schema": { - "$ref": "#/components/schemas/TestResponse" + "schema" : { + "$ref" : "#/components/schemas/TestResponse" } } }, - "description": "The result of the test of a notification channel connection." + "description" : "The result of the test of a notification channel connection." } }, - "summary": "Test notification channel.", - "tags": [ - "Notification Channels", - "actions" - ] + "summary" : "Test notification channel.", + "tags" : [ "Notification Channels", "actions" ] } }, - "/api/v1/actions/notificationChannels/{notificationChannelId}/test": { - "post": { - "description": "Tests the existing notification channel by sending a test notification.", - "operationId": "testExistingNotificationChannel", - "parameters": [ - { - "in": "path", - "name": "notificationChannelId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestDestinationRequest" + "/api/v1/actions/notificationChannels/{notificationChannelId}/test" : { + "post" : { + "description" : "Tests the existing notification channel by sending a test notification.", + "operationId" : "testExistingNotificationChannel", + "parameters" : [ { + "in" : "path", + "name" : "notificationChannelId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TestDestinationRequest" } } } }, - "responses": { - "200": { - "content": { - "application/json": { - "examples": { - "An example of a successful connection": { - "description": "An example of a successful connection", - "value": { - "successful": true + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "An example of a successful connection" : { + "description" : "An example of a successful connection", + "value" : { + "successful" : true } }, - "An example of an unsuccessful connection": { - "description": "An example of an unsuccessful connection", - "value": { - "error": "Authentication failed", - "successful": false + "An example of an unsuccessful connection" : { + "description" : "An example of an unsuccessful connection", + "value" : { + "error" : "Authentication failed", + "successful" : false } } }, - "schema": { - "$ref": "#/components/schemas/TestResponse" + "schema" : { + "$ref" : "#/components/schemas/TestResponse" } } }, - "description": "The result of the test of a notification channel connection." + "description" : "The result of the test of a notification channel connection." } }, - "summary": "Test existing notification channel.", - "tags": [ - "Notification Channels", - "actions" - ] + "summary" : "Test existing notification channel.", + "tags" : [ "Notification Channels", "actions" ] } }, - "/api/v1/actions/notifications": { - "get": { - "description": "Get latest in-platform notifications for the current user.", - "operationId": "getNotifications", - "parameters": [ - { - "description": "Workspace ID to filter notifications by.", - "in": "query", - "name": "workspaceId", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "Filter notifications by read status.", - "in": "query", - "name": "isRead", - "required": false, - "schema": { - "type": "boolean" - }, - "style": "form" - }, - { - "description": "Zero-based page index (0..N)", - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": "0", - "minimum": 0, - "type": "string" - }, - "style": "form" - }, - { - "description": "The size of the page to be returned.", - "in": "query", - "name": "size", - "required": false, - "schema": { - "default": "20", - "minimum": 1, - "type": "string" - }, - "style": "form" - }, - { - "description": "Additional meta information to include in the response.", - "explode": true, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "items": { - "enum": [ - "total", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Notifications" + "/api/v1/actions/notifications" : { + "get" : { + "description" : "Get latest in-platform notifications for the current user.", + "operationId" : "getNotifications", + "parameters" : [ { + "description" : "Workspace ID to filter notifications by.", + "in" : "query", + "name" : "workspaceId", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Filter notifications by read status.", + "in" : "query", + "name" : "isRead", + "required" : false, + "schema" : { + "type" : "boolean" + }, + "style" : "form" + }, { + "description" : "Zero-based page index (0..N)", + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : "0", + "minimum" : 0, + "type" : "string" + }, + "style" : "form" + }, { + "description" : "The size of the page to be returned.", + "in" : "query", + "name" : "size", + "required" : false, + "schema" : { + "default" : "20", + "minimum" : 1, + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Additional meta information to include in the response.", + "explode" : true, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "total", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Notifications" } } }, - "description": "OK" + "description" : "OK" } }, - "summary": "Get latest notifications.", - "tags": [ - "Notification Channels", - "actions" - ] + "summary" : "Get latest notifications.", + "tags" : [ "Notification Channels", "actions" ] } }, - "/api/v1/actions/notifications/markAsRead": { - "post": { - "description": "Mark all user in-platform notifications as read.", - "operationId": "markAsReadNotificationAll", - "parameters": [ - { - "description": "Workspace ID where to mark notifications as read.", - "in": "query", - "name": "workspaceId", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - } - ], - "responses": { - "204": { - "description": "No Content" - } - }, - "summary": "Mark all notifications as read.", - "tags": [ - "Notification Channels", - "actions" - ] + "/api/v1/actions/notifications/markAsRead" : { + "post" : { + "description" : "Mark all user in-platform notifications as read.", + "operationId" : "markAsReadNotificationAll", + "parameters" : [ { + "description" : "Workspace ID where to mark notifications as read.", + "in" : "query", + "name" : "workspaceId", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + } ], + "responses" : { + "204" : { + "description" : "No Content" + } + }, + "summary" : "Mark all notifications as read.", + "tags" : [ "Notification Channels", "actions" ] } }, - "/api/v1/actions/notifications/{notificationId}/markAsRead": { - "post": { - "description": "Mark in-platform notification by its ID as read.", - "operationId": "markAsReadNotification", - "parameters": [ - { - "description": "Notification ID to mark as read.", - "in": "path", - "name": "notificationId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "No Content" - } - }, - "summary": "Mark notification as read.", - "tags": [ - "Notification Channels", - "actions" - ] + "/api/v1/actions/notifications/{notificationId}/markAsRead" : { + "post" : { + "description" : "Mark in-platform notification by its ID as read.", + "operationId" : "markAsReadNotification", + "parameters" : [ { + "description" : "Notification ID to mark as read.", + "in" : "path", + "name" : "notificationId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No Content" + } + }, + "summary" : "Mark notification as read.", + "tags" : [ "Notification Channels", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/automations/trigger": { - "post": { - "description": "Trigger the automation in the request.", - "operationId": "triggerAutomation", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TriggerAutomationRequest" + "/api/v1/actions/workspaces/{workspaceId}/automations/trigger" : { + "post" : { + "description" : "Trigger the automation in the request.", + "operationId" : "triggerAutomation", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TriggerAutomationRequest" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "The automation is successfully triggered." + "responses" : { + "204" : { + "description" : "The automation is successfully triggered." } }, - "summary": "Trigger automation.", - "tags": [ - "Automations", - "actions" - ] + "summary" : "Trigger automation.", + "tags" : [ "Automations", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger": { - "post": { - "description": "Trigger the existing automation to execute immediately.", - "operationId": "triggerExistingAutomation", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "automationId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The automation is successfully triggered." - } - }, - "summary": "Trigger existing automation.", - "tags": [ - "Automations", - "actions" - ] + "/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger" : { + "post" : { + "description" : "Trigger the existing automation to execute immediately.", + "operationId" : "triggerExistingAutomation", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "automationId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "The automation is successfully triggered." + } + }, + "summary" : "Trigger existing automation.", + "tags" : [ "Automations", "actions" ] } } }, - "servers": [ - { - "description": "GoodData.CN endpoint", - "url": "/" - } - ], - "tags": [ - { - "description": "| execution of some form of computation (RPC over JSON)", - "name": "actions" - } - ] + "servers" : [ { + "description" : "GoodData.CN endpoint", + "url" : "/" + } ], + "tags" : [ { + "description" : "| execution of some form of computation (RPC over JSON)", + "name" : "actions" + } ] } diff --git a/schemas/gooddata-export-client.json b/schemas/gooddata-export-client.json index 816986175..50ecd9fd1 100644 --- a/schemas/gooddata-export-client.json +++ b/schemas/gooddata-export-client.json @@ -1,3122 +1,2519 @@ { - "components": { - "schemas": { - "AFM": { - "description": "Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.", - "properties": { - "attributes": { - "description": "Attributes to be used in the computation.", - "items": { - "$ref": "#/components/schemas/AttributeItem" - }, - "type": "array" - }, - "auxMeasures": { - "description": "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "type": "array" - }, - "filters": { - "description": "Various filter types to filter the execution result.", - "items": { - "$ref": "#/components/schemas/FilterDefinition" - }, - "type": "array" - }, - "measures": { - "description": "Metrics to be computed.", - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "type": "array" - } - }, - "required": [ - "attributes", - "filters", - "measures" - ], - "type": "object" - }, - "AbsoluteDateFilter": { - "description": "A datetime filter specifying exact from and to values.", - "properties": { - "absoluteDateFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" - }, - "from": { - "example": "2020-07-01 18:23", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", - "type": "string" - }, - "includeEmptyValues": { - "description": "If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).", - "type": "boolean" - }, - "localIdentifier": { - "type": "string" - }, - "to": { - "example": "2020-07-16 23:59", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", - "type": "string" + "components" : { + "schemas" : { + "AFM" : { + "description" : "Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.", + "properties" : { + "attributes" : { + "description" : "Attributes to be used in the computation.", + "items" : { + "$ref" : "#/components/schemas/AttributeItem" + }, + "type" : "array" + }, + "auxMeasures" : { + "description" : "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", + "items" : { + "$ref" : "#/components/schemas/MeasureItem" + }, + "type" : "array" + }, + "filters" : { + "description" : "Various filter types to filter the execution result.", + "items" : { + "$ref" : "#/components/schemas/FilterDefinition" + }, + "type" : "array" + }, + "measures" : { + "description" : "Metrics to be computed.", + "items" : { + "$ref" : "#/components/schemas/MeasureItem" + }, + "type" : "array" + } + }, + "required" : [ "attributes", "filters", "measures" ], + "type" : "object" + }, + "AbsoluteDateFilter" : { + "description" : "A datetime filter specifying exact from and to values.", + "properties" : { + "absoluteDateFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "dataset" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierDataset" + }, + "from" : { + "example" : "2020-07-01 18:23", + "pattern" : "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "type" : "string" + }, + "localIdentifier" : { + "type" : "string" + }, + "to" : { + "example" : "2020-07-16 23:59", + "pattern" : "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "type" : "string" } }, - "required": [ - "from", - "to", - "dataset" - ], - "type": "object" - } - }, - "required": [ - "absoluteDateFilter" - ], - "type": "object" - }, - "AbstractMeasureValueFilter": { - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/RangeMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/CompoundMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/RankingFilter" - } - ], - "type": "object" - }, - "AfmIdentifier": { - "description": "Reference to the attribute label to which the filter should be applied.", - "oneOf": [ - { - "$ref": "#/components/schemas/AfmObjectIdentifier" - }, - { - "$ref": "#/components/schemas/AfmLocalIdentifier" - } - ], - "type": "object" - }, - "AfmLocalIdentifier": { - "properties": { - "localIdentifier": { - "example": "sampleAutoGenerated0123_ID", - "pattern": "^[.a-zA-Z0-9_-]+$", - "type": "string" - } - }, - "required": [ - "localIdentifier" - ], - "type": "object" - }, - "AfmObjectIdentifier": { - "description": "ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.", - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "enum": [ - "analyticalDashboard", - "attribute", - "dashboardPlugin", - "dataset", - "fact", - "label", - "metric", - "prompt", - "visualizationObject", - "filterContext" - ], - "example": "fact", - "type": "string" + "required" : [ "from", "to", "dataset" ], + "type" : "object" + } + }, + "required" : [ "absoluteDateFilter" ], + "type" : "object" + }, + "AbstractMeasureValueFilter" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/ComparisonMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/RangeMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/CompoundMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/RankingFilter" + } ], + "type" : "object" + }, + "AfmIdentifier" : { + "description" : "Reference to the attribute label to which the filter should be applied.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AfmObjectIdentifier" + }, { + "$ref" : "#/components/schemas/AfmLocalIdentifier" + } ], + "type" : "object" + }, + "AfmLocalIdentifier" : { + "properties" : { + "localIdentifier" : { + "example" : "sampleAutoGenerated0123_ID", + "pattern" : "^[.a-zA-Z0-9_-]+$", + "type" : "string" + } + }, + "required" : [ "localIdentifier" ], + "type" : "object" + }, + "AfmObjectIdentifier" : { + "description" : "ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.", + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "enum" : [ "analyticalDashboard", "attribute", "dashboardPlugin", "dataset", "fact", "label", "metric", "prompt", "visualizationObject", "filterContext" ], + "example" : "fact", + "type" : "string" } }, - "required": [ - "type", - "id" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AfmObjectIdentifierAttribute": { - "description": "Reference to the date attribute to use.", - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "enum": [ - "attribute" - ], - "type": "string" + "required" : [ "type", "id" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AfmObjectIdentifierAttribute" : { + "description" : "Reference to the date attribute to use.", + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "enum" : [ "attribute" ], + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AfmObjectIdentifierCore": { - "description": "Reference to the metric, fact or attribute object to use for the metric.", - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "enum": [ - "attribute", - "label", - "fact", - "metric" - ], - "type": "string" + "required" : [ "id", "type" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AfmObjectIdentifierCore" : { + "description" : "Reference to the metric, fact or attribute object to use for the metric.", + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "enum" : [ "attribute", "label", "fact", "metric" ], + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AfmObjectIdentifierDataset": { - "description": "Reference to the date dataset to which the filter should be applied.", - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "enum": [ - "dataset" - ], - "type": "string" + "required" : [ "id", "type" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AfmObjectIdentifierDataset" : { + "description" : "Reference to the date dataset to which the filter should be applied.", + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "enum" : [ "dataset" ], + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AfmObjectIdentifierLabel": { - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "enum": [ - "label" - ], - "type": "string" + "required" : [ "id", "type" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AfmObjectIdentifierLabel" : { + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "enum" : [ "label" ], + "type" : "string" } }, - "required": [ - "type", - "id" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "ArithmeticMeasureDefinition": { - "description": "Metric representing arithmetics between other metrics.", - "properties": { - "arithmeticMeasure": { - "properties": { - "measureIdentifiers": { - "description": "List of metrics to apply arithmetic operation by chosen operator.", - "items": { - "$ref": "#/components/schemas/AfmLocalIdentifier" + "required" : [ "type", "id" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "ArithmeticMeasureDefinition" : { + "description" : "Metric representing arithmetics between other metrics.", + "properties" : { + "arithmeticMeasure" : { + "properties" : { + "measureIdentifiers" : { + "description" : "List of metrics to apply arithmetic operation by chosen operator.", + "items" : { + "$ref" : "#/components/schemas/AfmLocalIdentifier" }, - "type": "array" - }, - "operator": { - "description": "Arithmetic operator describing operation between metrics.", - "enum": [ - "SUM", - "DIFFERENCE", - "MULTIPLICATION", - "RATIO", - "CHANGE" - ], - "example": "SUM", - "type": "string" + "type" : "array" + }, + "operator" : { + "description" : "Arithmetic operator describing operation between metrics.", + "enum" : [ "SUM", "DIFFERENCE", "MULTIPLICATION", "RATIO", "CHANGE" ], + "example" : "SUM", + "type" : "string" } }, - "required": [ - "measureIdentifiers", - "operator" - ], - "type": "object" + "required" : [ "measureIdentifiers", "operator" ], + "type" : "object" } - }, - "required": [ - "arithmeticMeasure" - ], - "type": "object" + }, + "required" : [ "arithmeticMeasure" ], + "type" : "object" }, - "AttributeElements": { - "oneOf": [ - { - "$ref": "#/components/schemas/AttributeElementsByRef" - }, - { - "$ref": "#/components/schemas/AttributeElementsByValue" + "AttributeElements" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/AttributeElementsByRef" + }, { + "$ref" : "#/components/schemas/AttributeElementsByValue" + } ], + "type" : "object" + }, + "AttributeElementsByRef" : { + "properties" : { + "uris" : { + "description" : "List of attribute elements by reference", + "items" : { + "nullable" : true, + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ "uris" ], + "type" : "object" + }, + "AttributeElementsByValue" : { + "properties" : { + "values" : { + "description" : "List of attribute elements by value", + "items" : { + "nullable" : true, + "type" : "string" + }, + "type" : "array" } - ], - "type": "object" - }, - "AttributeElementsByRef": { - "properties": { - "uris": { - "description": "List of attribute elements by reference", - "items": { - "nullable": true, - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "uris" - ], - "type": "object" - }, - "AttributeElementsByValue": { - "properties": { - "values": { - "description": "List of attribute elements by value", - "items": { - "nullable": true, - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "values" - ], - "type": "object" - }, - "AttributeFilter": { - "description": "Abstract filter definition type attributes", - "oneOf": [ - { - "$ref": "#/components/schemas/NegativeAttributeFilter" - }, - { - "$ref": "#/components/schemas/PositiveAttributeFilter" - } - ], - "type": "object" - }, - "AttributeFilterByDate": { - "properties": { - "filterLocalIdentifier": { - "type": "string" - }, - "isCommonDate": { - "type": "boolean" - } - }, - "required": [ - "filterLocalIdentifier", - "isCommonDate" - ], - "type": "object" - }, - "AttributeFilterElements": { - "description": "Filter on specific set of label values.", - "properties": { - "values": { - "description": "Set of label values.", - "example": [ - "value1", - "value2" - ], - "items": { - "nullable": true, - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "values" - ], - "type": "object" - }, - "AttributeFilterParent": { - "properties": { - "filterLocalIdentifier": { - "type": "string" - }, - "over": { - "$ref": "#/components/schemas/Over" - } - }, - "required": [ - "filterLocalIdentifier", - "over" - ], - "type": "object" - }, - "AttributeItem": { - "properties": { - "label": { - "$ref": "#/components/schemas/AfmObjectIdentifierLabel" - }, - "localIdentifier": { - "description": "Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.", - "example": "attribute_1", - "pattern": "^[.a-zA-Z0-9_-]+$", - "type": "string" - }, - "showAllValues": { - "default": false, - "description": "Indicates whether to show all values of given attribute even if the data bound to those values is not available.", - "type": "boolean" - } - }, - "required": [ - "label", - "localIdentifier" - ], - "type": "object" - }, - "BoundedFilter": { - "description": "Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range.", - "properties": { - "from": { - "description": "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). If null, then start of the range is unbounded.", - "example": -6, - "format": "int32", - "nullable": true, - "type": "integer" - }, - "granularity": { - "description": "Date granularity specifying particular date attribute in given dimension.", - "enum": [ - "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", - "MINUTE_OF_HOUR", - "HOUR_OF_DAY", - "DAY_OF_WEEK", - "DAY_OF_MONTH", - "DAY_OF_QUARTER", - "DAY_OF_YEAR", - "WEEK_OF_YEAR", - "MONTH_OF_YEAR", - "QUARTER_OF_YEAR", - "FISCAL_MONTH", - "FISCAL_QUARTER", - "FISCAL_YEAR" - ], - "example": "DAY", - "type": "string" - }, - "to": { - "description": "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.", - "example": 0, - "format": "int32", - "nullable": true, - "type": "integer" - } - }, - "required": [ - "granularity" - ], - "type": "object" - }, - "ComparisonCondition": { - "description": "Condition that compares the metric value to a given constant value using a comparison operator.", - "properties": { - "comparison": { - "properties": { - "operator": { - "enum": [ - "GREATER_THAN", - "GREATER_THAN_OR_EQUAL_TO", - "LESS_THAN", - "LESS_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO" - ], - "example": "GREATER_THAN", - "type": "string" - }, - "value": { - "example": 100, - "type": "number" + }, + "required" : [ "values" ], + "type" : "object" + }, + "AttributeFilter" : { + "description" : "Abstract filter definition type attributes", + "oneOf" : [ { + "$ref" : "#/components/schemas/NegativeAttributeFilter" + }, { + "$ref" : "#/components/schemas/PositiveAttributeFilter" + } ], + "type" : "object" + }, + "AttributeFilterByDate" : { + "properties" : { + "filterLocalIdentifier" : { + "type" : "string" + }, + "isCommonDate" : { + "type" : "boolean" + } + }, + "required" : [ "filterLocalIdentifier", "isCommonDate" ], + "type" : "object" + }, + "AttributeFilterElements" : { + "description" : "Filter on specific set of label values.", + "properties" : { + "values" : { + "description" : "Set of label values.", + "example" : [ "value1", "value2" ], + "items" : { + "nullable" : true, + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "values" ], + "type" : "object" + }, + "AttributeFilterParent" : { + "properties" : { + "filterLocalIdentifier" : { + "type" : "string" + }, + "over" : { + "$ref" : "#/components/schemas/Over" + } + }, + "required" : [ "filterLocalIdentifier", "over" ], + "type" : "object" + }, + "AttributeItem" : { + "properties" : { + "label" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierLabel" + }, + "localIdentifier" : { + "description" : "Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.", + "example" : "attribute_1", + "pattern" : "^[.a-zA-Z0-9_-]+$", + "type" : "string" + }, + "showAllValues" : { + "default" : false, + "description" : "Indicates whether to show all values of given attribute even if the data bound to those values is not available.", + "type" : "boolean" + } + }, + "required" : [ "label", "localIdentifier" ], + "type" : "object" + }, + "BoundedFilter" : { + "description" : "Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range.", + "properties" : { + "from" : { + "description" : "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). If null, then start of the range is unbounded.", + "example" : -6, + "format" : "int32", + "nullable" : true, + "type" : "integer" + }, + "granularity" : { + "description" : "Date granularity specifying particular date attribute in given dimension.", + "enum" : [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], + "example" : "DAY", + "type" : "string" + }, + "to" : { + "description" : "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.", + "example" : 0, + "format" : "int32", + "nullable" : true, + "type" : "integer" + } + }, + "required" : [ "granularity" ], + "type" : "object" + }, + "ComparisonCondition" : { + "description" : "Condition that compares the metric value to a given constant value using a comparison operator.", + "properties" : { + "comparison" : { + "properties" : { + "operator" : { + "enum" : [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ], + "example" : "GREATER_THAN", + "type" : "string" + }, + "value" : { + "example" : 100, + "type" : "number" } }, - "required": [ - "operator", - "value" - ], - "type": "object" - } - }, - "required": [ - "comparison" - ], - "type": "object" - }, - "ComparisonMeasureValueFilter": { - "description": "Filter the result by comparing specified metric to given constant value, using given comparison operator.", - "properties": { - "comparisonMeasureValueFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" + "required" : [ "operator", "value" ], + "type" : "object" + } + }, + "required" : [ "comparison" ], + "type" : "object" + }, + "ComparisonMeasureValueFilter" : { + "description" : "Filter the result by comparing specified metric to given constant value, using given comparison operator.", + "properties" : { + "comparisonMeasureValueFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "dimensionality" : { + "description" : "References to the attributes to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "type": "array" - }, - "localIdentifier": { - "type": "string" - }, - "measure": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "operator": { - "enum": [ - "GREATER_THAN", - "GREATER_THAN_OR_EQUAL_TO", - "LESS_THAN", - "LESS_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO" - ], - "example": "GREATER_THAN", - "type": "string" - }, - "treatNullValuesAs": { - "description": "A value that will be substituted for null values in the metric for the comparisons.", - "example": 0, - "type": "number" - }, - "value": { - "example": 1327, - "type": "number" + "type" : "array" + }, + "localIdentifier" : { + "type" : "string" + }, + "measure" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "operator" : { + "enum" : [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ], + "example" : "GREATER_THAN", + "type" : "string" + }, + "treatNullValuesAs" : { + "description" : "A value that will be substituted for null values in the metric for the comparisons.", + "example" : 0, + "type" : "number" + }, + "value" : { + "example" : 1327, + "type" : "number" } }, - "required": [ - "operator", - "value", - "measure" - ], - "type": "object" - } - }, - "required": [ - "comparisonMeasureValueFilter" - ], - "type": "object" - }, - "CompoundMeasureValueFilter": { - "description": "Filter the result by applying multiple comparison and/or range conditions combined with OR logic. If conditions list is empty, no filtering is applied (all rows are returned).", - "properties": { - "compoundMeasureValueFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "conditions": { - "description": "List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned.", - "items": { - "$ref": "#/components/schemas/MeasureValueCondition" + "required" : [ "operator", "value", "measure" ], + "type" : "object" + } + }, + "required" : [ "comparisonMeasureValueFilter" ], + "type" : "object" + }, + "CompoundMeasureValueFilter" : { + "description" : "Filter the result by applying multiple comparison and/or range conditions combined with OR logic. If conditions list is empty, no filtering is applied (all rows are returned).", + "properties" : { + "compoundMeasureValueFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "conditions" : { + "description" : "List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned.", + "items" : { + "$ref" : "#/components/schemas/MeasureValueCondition" }, - "type": "array" + "type" : "array" }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" + "dimensionality" : { + "description" : "References to the attributes to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "type": "array" + "type" : "array" }, - "localIdentifier": { - "type": "string" + "localIdentifier" : { + "type" : "string" }, - "measure": { - "$ref": "#/components/schemas/AfmIdentifier" + "measure" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "treatNullValuesAs": { - "description": "A value that will be substituted for null values in the metric for the comparisons.", - "example": 0, - "type": "number" + "treatNullValuesAs" : { + "description" : "A value that will be substituted for null values in the metric for the comparisons.", + "example" : 0, + "type" : "number" } }, - "required": [ - "conditions", - "measure" - ], - "type": "object" + "required" : [ "conditions", "measure" ], + "type" : "object" } }, - "required": [ - "compoundMeasureValueFilter" - ], - "type": "object" + "required" : [ "compoundMeasureValueFilter" ], + "type" : "object" }, - "CustomLabel": { - "description": "Custom label object override.", - "properties": { - "title": { - "description": "Override value.", - "type": "string" + "CustomLabel" : { + "description" : "Custom label object override.", + "properties" : { + "title" : { + "description" : "Override value.", + "type" : "string" } }, - "required": [ - "title" - ], - "type": "object" + "required" : [ "title" ], + "type" : "object" }, - "CustomMetric": { - "description": "Custom metric object override.", - "properties": { - "format": { - "description": "Format override.", - "type": "string" + "CustomMetric" : { + "description" : "Custom metric object override.", + "properties" : { + "format" : { + "description" : "Format override.", + "type" : "string" }, - "title": { - "description": "Metric title override.", - "type": "string" + "title" : { + "description" : "Metric title override.", + "type" : "string" } }, - "required": [ - "format", - "title" - ], - "type": "object" + "required" : [ "format", "title" ], + "type" : "object" }, - "CustomOverride": { - "description": "Custom cell value overrides (IDs will be replaced with specified values).", - "properties": { - "labels": { - "additionalProperties": { - "$ref": "#/components/schemas/CustomLabel" + "CustomOverride" : { + "description" : "Custom cell value overrides (IDs will be replaced with specified values).", + "properties" : { + "labels" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/CustomLabel" }, - "description": "Map of CustomLabels with keys used as placeholders in document.", - "type": "object" + "description" : "Map of CustomLabels with keys used as placeholders in document.", + "type" : "object" }, - "metrics": { - "additionalProperties": { - "$ref": "#/components/schemas/CustomMetric" + "metrics" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/CustomMetric" }, - "description": "Map of CustomMetrics with keys used as placeholders in document.", - "type": "object" + "description" : "Map of CustomMetrics with keys used as placeholders in document.", + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "DashboardAttributeFilter": { - "properties": { - "attributeFilter": { - "properties": { - "attributeElements": { - "$ref": "#/components/schemas/AttributeElements" + "DashboardAttributeFilter" : { + "properties" : { + "attributeFilter" : { + "properties" : { + "attributeElements" : { + "$ref" : "#/components/schemas/AttributeElements" }, - "displayForm": { - "$ref": "#/components/schemas/IdentifierRef" + "displayForm" : { + "$ref" : "#/components/schemas/IdentifierRef" }, - "filterElementsBy": { - "items": { - "$ref": "#/components/schemas/AttributeFilterParent" + "filterElementsBy" : { + "items" : { + "$ref" : "#/components/schemas/AttributeFilterParent" }, - "type": "array" + "type" : "array" }, - "filterElementsByDate": { - "items": { - "$ref": "#/components/schemas/AttributeFilterByDate" + "filterElementsByDate" : { + "items" : { + "$ref" : "#/components/schemas/AttributeFilterByDate" }, - "type": "array" + "type" : "array" }, - "localIdentifier": { - "type": "string" + "localIdentifier" : { + "type" : "string" }, - "negativeSelection": { - "type": "boolean" + "negativeSelection" : { + "type" : "boolean" }, - "selectionMode": { - "enum": [ - "single", - "multi" - ], - "type": "string" + "selectionMode" : { + "enum" : [ "single", "multi" ], + "type" : "string" }, - "title": { - "type": "string" + "title" : { + "type" : "string" }, - "validateElementsBy": { - "items": { - "$ref": "#/components/schemas/IdentifierRef" + "validateElementsBy" : { + "items" : { + "$ref" : "#/components/schemas/IdentifierRef" }, - "type": "array" + "type" : "array" } }, - "required": [ - "attributeElements", - "displayForm", - "negativeSelection" - ], - "type": "object" + "required" : [ "attributeElements", "displayForm", "negativeSelection" ], + "type" : "object" } }, - "required": [ - "attributeFilter" - ], - "type": "object" + "required" : [ "attributeFilter" ], + "type" : "object" }, - "DashboardDateFilter": { - "properties": { - "dateFilter": { - "properties": { - "attribute": { - "$ref": "#/components/schemas/IdentifierRef" + "DashboardDateFilter" : { + "properties" : { + "dateFilter" : { + "properties" : { + "attribute" : { + "$ref" : "#/components/schemas/IdentifierRef" }, - "boundedFilter": { - "$ref": "#/components/schemas/RelativeBoundedDateFilter" + "boundedFilter" : { + "$ref" : "#/components/schemas/RelativeBoundedDateFilter" }, - "dataSet": { - "$ref": "#/components/schemas/IdentifierRef" + "dataSet" : { + "$ref" : "#/components/schemas/IdentifierRef" }, - "from": { - "oneOf": [ - { - "type": "string" - }, - { - "format": "int32", - "type": "integer" - } - ] - }, - "granularity": { - "enum": [ - "ALL_TIME_GRANULARITY", - "GDC.time.year", - "GDC.time.week_us", - "GDC.time.week_in_year", - "GDC.time.week_in_quarter", - "GDC.time.week", - "GDC.time.euweek_in_year", - "GDC.time.euweek_in_quarter", - "GDC.time.quarter", - "GDC.time.quarter_in_year", - "GDC.time.month", - "GDC.time.month_in_quarter", - "GDC.time.month_in_year", - "GDC.time.day_in_year", - "GDC.time.day_in_quarter", - "GDC.time.day_in_month", - "GDC.time.day_in_week", - "GDC.time.day_in_euweek", - "GDC.time.date", - "GDC.time.hour", - "GDC.time.hour_in_day", - "GDC.time.minute", - "GDC.time.minute_in_hour", - "GDC.time.fiscal_month", - "GDC.time.fiscal_quarter", - "GDC.time.fiscal_year" - ], - "type": "string" - }, - "includeEmptyValues": { - "type": "boolean" - }, - "localIdentifier": { - "type": "string" - }, - "to": { - "oneOf": [ - { - "type": "string" - }, - { - "format": "int32", - "type": "integer" - } - ] - }, - "type": { - "enum": [ - "relative", - "absolute" - ], - "type": "string" + "from" : { + "oneOf" : [ { + "type" : "string" + }, { + "format" : "int32", + "type" : "integer" + } ] + }, + "granularity" : { + "enum" : [ "ALL_TIME_GRANULARITY", "GDC.time.year", "GDC.time.week_us", "GDC.time.week_in_year", "GDC.time.week_in_quarter", "GDC.time.week", "GDC.time.euweek_in_year", "GDC.time.euweek_in_quarter", "GDC.time.quarter", "GDC.time.quarter_in_year", "GDC.time.month", "GDC.time.month_in_quarter", "GDC.time.month_in_year", "GDC.time.day_in_year", "GDC.time.day_in_quarter", "GDC.time.day_in_month", "GDC.time.day_in_week", "GDC.time.day_in_euweek", "GDC.time.date", "GDC.time.hour", "GDC.time.hour_in_day", "GDC.time.minute", "GDC.time.minute_in_hour", "GDC.time.fiscal_month", "GDC.time.fiscal_quarter", "GDC.time.fiscal_year" ], + "type" : "string" + }, + "localIdentifier" : { + "type" : "string" + }, + "to" : { + "oneOf" : [ { + "type" : "string" + }, { + "format" : "int32", + "type" : "integer" + } ] + }, + "type" : { + "enum" : [ "relative", "absolute" ], + "type" : "string" } }, - "required": [ - "granularity", - "type" - ], - "type": "object" - } - }, - "required": [ - "dateFilter" - ], - "type": "object" - }, - "DashboardExportSettings": { - "description": "Additional settings.", - "properties": { - "exportInfo": { - "default": false, - "description": "If true, the export will contain the information about the export – exported date, dashboard filters, etc.", - "example": true, - "type": "boolean" - }, - "mergeHeaders": { - "default": false, - "description": "Merge equal headers in neighbouring cells. Used for [XLSX] format only.", - "example": true, - "type": "boolean" - }, - "pageOrientation": { - "default": "PORTRAIT", - "description": "Set page orientation. (PDF)", - "enum": [ - "PORTRAIT", - "LANDSCAPE" - ], - "type": "string" - }, - "pageSize": { - "default": "A4", - "description": "Set page size. (PDF)", - "enum": [ - "A3", - "A4", - "LETTER" - ], - "type": "string" - } - }, - "type": "object" - }, - "DashboardFilter": { - "oneOf": [ - { - "$ref": "#/components/schemas/DashboardAttributeFilter" - }, - { - "$ref": "#/components/schemas/DashboardDateFilter" - } - ], - "type": "object" - }, - "DashboardTabularExportRequest": { - "description": "Export request object describing the export properties for dashboard tabular exports.", - "properties": { - "dashboardFiltersOverride": { - "description": "List of filters that will be used instead of the default dashboard filters.", - "items": { - "$ref": "#/components/schemas/DashboardFilter" - }, - "type": "array" - }, - "dashboardTabsFiltersOverrides": { - "additionalProperties": { - "items": { - "$ref": "#/components/schemas/DashboardFilter" - }, - "type": "array" - }, - "description": "Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.", - "type": "object" - }, - "fileName": { - "description": "Filename of downloaded file without extension.", - "example": "result", - "type": "string" - }, - "format": { - "description": "Requested tabular export type.", - "enum": [ - "XLSX", - "PDF" - ], - "example": "XLSX", - "type": "string" - }, - "settings": { - "$ref": "#/components/schemas/DashboardExportSettings" - }, - "widgetIds": { - "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", - "items": { - "type": "string" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "fileName", - "format" - ], - "type": "object" - }, - "DateFilter": { - "description": "Abstract filter definition type for dates.", - "oneOf": [ - { - "$ref": "#/components/schemas/AbsoluteDateFilter" - }, - { - "$ref": "#/components/schemas/RelativeDateFilter" - } - ], - "type": "object" - }, - "DateValue": { - "properties": { - "value": { - "type": "string" - } - }, - "required": [ - "value" - ], - "type": "object" - }, - "ExecutionSettings": { - "description": "Various settings affecting the process of AFM execution or its result", - "properties": { - "dataSamplingPercentage": { - "description": "Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.", - "exclusiveMaximum": true, - "exclusiveMinimum": true, - "format": "float", - "maximum": 100, - "minimum": 0, - "type": "number" - }, - "timestamp": { - "description": "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "ExportResponse": { - "properties": { - "exportResult": { - "type": "string" - } - }, - "required": [ - "exportResult" - ], - "type": "object" - }, - "FilterDefinition": { - "description": "Abstract filter definition type", - "oneOf": [ - { - "$ref": "#/components/schemas/InlineFilterDefinition" - }, - { - "$ref": "#/components/schemas/RankingFilter" - }, - { - "$ref": "#/components/schemas/ComparisonMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/RangeMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/CompoundMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/AbsoluteDateFilter" - }, - { - "$ref": "#/components/schemas/RelativeDateFilter" - }, - { - "$ref": "#/components/schemas/NegativeAttributeFilter" - }, - { - "$ref": "#/components/schemas/PositiveAttributeFilter" - } - ], - "type": "object" - }, - "FilterDefinitionForSimpleMeasure": { - "description": "Abstract filter definition type for simple metric.", - "oneOf": [ - { - "$ref": "#/components/schemas/DateFilter" - }, - { - "$ref": "#/components/schemas/AttributeFilter" - } - ], - "type": "object" - }, - "IdentifierRef": { - "properties": { - "identifier": { - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "analyticalDashboard", - "attribute", - "attributeHierarchy", - "dashboardPlugin", - "dataset", - "fact", - "aggregatedFact", - "label", - "metric", - "userDataFilter", - "exportDefinition", - "automation", - "automationResult", - "memoryItem", - "knowledgeRecommendation", - "prompt", - "visualizationObject", - "filterContext", - "workspaceSettings", - "customApplicationSetting", - "workspaceDataFilter", - "workspaceDataFilterSetting", - "filterView" - ], - "type": "string" + "required" : [ "granularity", "type" ], + "type" : "object" + } + }, + "required" : [ "dateFilter" ], + "type" : "object" + }, + "DashboardExportSettings" : { + "description" : "Additional settings.", + "properties" : { + "exportInfo" : { + "default" : false, + "description" : "If true, the export will contain the information about the export – exported date, dashboard filters, etc.", + "example" : true, + "type" : "boolean" + }, + "mergeHeaders" : { + "default" : false, + "description" : "Merge equal headers in neighbouring cells. Used for [XLSX] format only.", + "example" : true, + "type" : "boolean" + }, + "pageOrientation" : { + "default" : "PORTRAIT", + "description" : "Set page orientation. (PDF)", + "enum" : [ "PORTRAIT", "LANDSCAPE" ], + "type" : "string" + }, + "pageSize" : { + "default" : "A4", + "description" : "Set page size. (PDF)", + "enum" : [ "A3", "A4", "LETTER" ], + "type" : "string" + } + }, + "type" : "object" + }, + "DashboardFilter" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/DashboardAttributeFilter" + }, { + "$ref" : "#/components/schemas/DashboardDateFilter" + } ], + "type" : "object" + }, + "DashboardTabularExportRequest" : { + "description" : "Export request object describing the export properties for dashboard tabular exports.", + "properties" : { + "dashboardFiltersOverride" : { + "description" : "List of filters that will be used instead of the default dashboard filters.", + "items" : { + "$ref" : "#/components/schemas/DashboardFilter" + }, + "type" : "array" + }, + "dashboardTabsFiltersOverrides" : { + "additionalProperties" : { + "items" : { + "$ref" : "#/components/schemas/DashboardFilter" + }, + "type" : "array" + }, + "description" : "Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.", + "type" : "object" + }, + "fileName" : { + "description" : "Filename of downloaded file without extension.", + "example" : "result", + "type" : "string" + }, + "format" : { + "description" : "Requested tabular export type.", + "enum" : [ "XLSX", "PDF" ], + "example" : "XLSX", + "type" : "string" + }, + "settings" : { + "$ref" : "#/components/schemas/DashboardExportSettings" + }, + "widgetIds" : { + "description" : "List of widget identifiers to be exported. Note that only one widget is currently supported.", + "items" : { + "type" : "string" + }, + "maxItems" : 1, + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "fileName", "format" ], + "type" : "object" + }, + "DateFilter" : { + "description" : "Abstract filter definition type for dates.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AbsoluteDateFilter" + }, { + "$ref" : "#/components/schemas/RelativeDateFilter" + } ], + "type" : "object" + }, + "DateValue" : { + "properties" : { + "value" : { + "type" : "string" + } + }, + "required" : [ "value" ], + "type" : "object" + }, + "ExecutionSettings" : { + "description" : "Various settings affecting the process of AFM execution or its result", + "properties" : { + "dataSamplingPercentage" : { + "description" : "Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.", + "exclusiveMaximum" : true, + "exclusiveMinimum" : true, + "format" : "float", + "maximum" : 100, + "minimum" : 0, + "type" : "number" + }, + "timestamp" : { + "description" : "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.", + "format" : "date-time", + "type" : "string" + } + }, + "type" : "object" + }, + "ExportResponse" : { + "properties" : { + "exportResult" : { + "type" : "string" + } + }, + "required" : [ "exportResult" ], + "type" : "object" + }, + "FilterDefinition" : { + "description" : "Abstract filter definition type", + "oneOf" : [ { + "$ref" : "#/components/schemas/InlineFilterDefinition" + }, { + "$ref" : "#/components/schemas/RankingFilter" + }, { + "$ref" : "#/components/schemas/ComparisonMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/RangeMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/CompoundMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/AbsoluteDateFilter" + }, { + "$ref" : "#/components/schemas/RelativeDateFilter" + }, { + "$ref" : "#/components/schemas/NegativeAttributeFilter" + }, { + "$ref" : "#/components/schemas/PositiveAttributeFilter" + } ], + "type" : "object" + }, + "FilterDefinitionForSimpleMeasure" : { + "description" : "Abstract filter definition type for simple metric.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DateFilter" + }, { + "$ref" : "#/components/schemas/AttributeFilter" + } ], + "type" : "object" + }, + "IdentifierRef" : { + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "analyticalDashboard", "attribute", "attributeHierarchy", "dashboardPlugin", "dataset", "fact", "aggregatedFact", "label", "metric", "userDataFilter", "exportDefinition", "automation", "automationResult", "memoryItem", "knowledgeRecommendation", "prompt", "visualizationObject", "filterContext", "workspaceSettings", "customApplicationSetting", "workspaceDataFilter", "workspaceDataFilterSetting", "filterView" ], + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "type": "object" - }, - "ImageExportRequest": { - "description": "Export request object describing the export properties and metadata for image exports.", - "properties": { - "dashboardId": { - "description": "Dashboard identifier", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - "type": "string" - }, - "fileName": { - "description": "File name to be used for retrieving the image document.", - "example": "filename", - "type": "string" - }, - "format": { - "description": "Requested resulting file type.", - "enum": [ - "PNG" - ], - "example": "PNG", - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/JsonNode" - }, - "widgetIds": { - "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "dashboardId", - "fileName", - "format", - "widgetIds" - ], - "type": "object" - }, - "InlineFilterDefinition": { - "description": "Filter in form of direct MAQL query.", - "properties": { - "inline": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "filter": { - "description": "MAQL query representing the filter.", - "type": "string" - }, - "localIdentifier": { - "type": "string" - } + "required" : [ "id", "type" ], + "type" : "object" + } + }, + "type" : "object" + }, + "ImageExportRequest" : { + "description" : "Export request object describing the export properties and metadata for image exports.", + "properties" : { + "dashboardId" : { + "description" : "Dashboard identifier", + "example" : "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type" : "string" + }, + "fileName" : { + "description" : "File name to be used for retrieving the image document.", + "example" : "filename", + "type" : "string" + }, + "format" : { + "description" : "Requested resulting file type.", + "enum" : [ "PNG" ], + "example" : "PNG", + "type" : "string" + }, + "metadata" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "widgetIds" : { + "description" : "List of widget identifiers to be exported. Note that only one widget is currently supported.", + "items" : { + "maxLength" : 255, + "minLength" : 1, + "type" : "string" }, - "required": [ - "filter" - ], - "type": "object" - } - }, - "required": [ - "inline" - ], - "type": "object" - }, - "InlineMeasureDefinition": { - "description": "Metric defined by the raw MAQL query.", - "properties": { - "inline": { - "properties": { - "maql": { - "description": "MAQL query defining the metric.", - "type": "string" + "maxItems" : 1, + "minItems" : 1, + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "dashboardId", "fileName", "format", "widgetIds" ], + "type" : "object" + }, + "InlineFilterDefinition" : { + "description" : "Filter in form of direct MAQL query.", + "properties" : { + "inline" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "filter" : { + "description" : "MAQL query representing the filter.", + "type" : "string" + }, + "localIdentifier" : { + "type" : "string" } }, - "required": [ - "maql" - ], - "type": "object" + "required" : [ "filter" ], + "type" : "object" } }, - "required": [ - "inline" - ], - "type": "object" + "required" : [ "inline" ], + "type" : "object" }, - "JsonNode": { - "description": "Metadata definition in free-form JSON format.", - "example": {}, - "maxLength": 15000, - "nullable": true, - "type": "object" + "InlineMeasureDefinition" : { + "description" : "Metric defined by the raw MAQL query.", + "properties" : { + "inline" : { + "properties" : { + "maql" : { + "description" : "MAQL query defining the metric.", + "type" : "string" + } + }, + "required" : [ "maql" ], + "type" : "object" + } + }, + "required" : [ "inline" ], + "type" : "object" + }, + "JsonNode" : { + "description" : "Metadata definition in free-form JSON format.", + "example" : { }, + "maxLength" : 15000, + "nullable" : true, + "type" : "object" + }, + "MeasureDefinition" : { + "description" : "Abstract metric definition type", + "oneOf" : [ { + "$ref" : "#/components/schemas/InlineMeasureDefinition" + }, { + "$ref" : "#/components/schemas/ArithmeticMeasureDefinition" + }, { + "$ref" : "#/components/schemas/SimpleMeasureDefinition" + }, { + "$ref" : "#/components/schemas/PopMeasureDefinition" + } ], + "type" : "object" + }, + "MeasureItem" : { + "description" : "Metric is a quantity that is calculated from the data.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/MeasureDefinition" + }, + "localIdentifier" : { + "description" : "Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.", + "example" : "metric_1", + "pattern" : "^[.a-zA-Z0-9_-]+$", + "type" : "string" + } + }, + "required" : [ "definition", "localIdentifier" ], + "type" : "object" + }, + "MeasureValueCondition" : { + "description" : "A condition for filtering by measure value. Can be either a comparison or a range condition.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ComparisonCondition" + }, { + "$ref" : "#/components/schemas/RangeCondition" + } ], + "type" : "object" + }, + "MeasureValueFilter" : { + "description" : "Abstract filter definition type filtering by the value of the metric.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ComparisonMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/RangeMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/CompoundMeasureValueFilter" + } ], + "type" : "object" + }, + "NegativeAttributeFilter" : { + "description" : "Filter able to limit element values by label and related selected negated elements.", + "properties" : { + "negativeAttributeFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "label" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "localIdentifier" : { + "type" : "string" + }, + "notIn" : { + "$ref" : "#/components/schemas/AttributeFilterElements" + } + }, + "required" : [ "notIn", "label" ], + "type" : "object" + } + }, + "required" : [ "negativeAttributeFilter" ], + "type" : "object" }, - "MeasureDefinition": { - "description": "Abstract metric definition type", - "oneOf": [ - { - "$ref": "#/components/schemas/InlineMeasureDefinition" - }, - { - "$ref": "#/components/schemas/ArithmeticMeasureDefinition" - }, - { - "$ref": "#/components/schemas/SimpleMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopMeasureDefinition" + "Over" : { + "properties" : { + "attributes" : { + "items" : { + "$ref" : "#/components/schemas/IdentifierRef" + }, + "type" : "array" } - ], - "type": "object" + }, + "required" : [ "attributes" ], + "type" : "object" }, - "MeasureItem": { - "description": "Metric is a quantity that is calculated from the data.", - "properties": { - "definition": { - "$ref": "#/components/schemas/MeasureDefinition" + "PdfTableStyle" : { + "deprecated" : true, + "description" : "Custom CSS styles for the table. (PDF, HTML)", + "example" : [ { + "properties" : [ { + "key" : "font-size", + "value" : "30px" + } ], + "selector" : "th" + } ], + "properties" : { + "properties" : { + "description" : "List of CSS properties.", + "items" : { + "$ref" : "#/components/schemas/PdfTableStyleProperty" + }, + "type" : "array" }, - "localIdentifier": { - "description": "Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.", - "example": "metric_1", - "pattern": "^[.a-zA-Z0-9_-]+$", - "type": "string" + "selector" : { + "description" : "CSS selector where to apply given properties.", + "type" : "string" } }, - "required": [ - "definition", - "localIdentifier" - ], - "type": "object" + "required" : [ "selector" ], + "type" : "object" }, - "MeasureValueCondition": { - "description": "A condition for filtering by measure value. Can be either a comparison or a range condition.", - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonCondition" + "PdfTableStyleProperty" : { + "description" : "CSS property.", + "properties" : { + "key" : { + "description" : "CSS property key.", + "type" : "string" }, - { - "$ref": "#/components/schemas/RangeCondition" + "value" : { + "description" : "CSS property value.", + "type" : "string" } - ], - "type": "object" + }, + "required" : [ "key", "value" ], + "type" : "object" }, - "MeasureValueFilter": { - "description": "Abstract filter definition type filtering by the value of the metric.", - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/RangeMeasureValueFilter" + "PopDataset" : { + "description" : "Combination of the date data set to use and how many periods ago to calculate the previous period for.", + "properties" : { + "dataset" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierDataset" }, - { - "$ref": "#/components/schemas/CompoundMeasureValueFilter" + "periodsAgo" : { + "description" : "Number of periods ago to calculate the previous period for.", + "example" : 1, + "format" : "int32", + "type" : "integer" } - ], - "type": "object" + }, + "required" : [ "dataset", "periodsAgo" ], + "type" : "object" }, - "NegativeAttributeFilter": { - "description": "Filter able to limit element values by label and related selected negated elements.", - "properties": { - "negativeAttributeFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "label": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "localIdentifier": { - "type": "string" - }, - "notIn": { - "$ref": "#/components/schemas/AttributeFilterElements" - } - }, - "required": [ - "notIn", - "label" - ], - "type": "object" - } - }, - "required": [ - "negativeAttributeFilter" - ], - "type": "object" - }, - "Over": { - "properties": { - "attributes": { - "items": { - "$ref": "#/components/schemas/IdentifierRef" - }, - "type": "array" - } - }, - "required": [ - "attributes" - ], - "type": "object" - }, - "PdfTableStyle": { - "deprecated": true, - "description": "Custom CSS styles for the table. (PDF, HTML)", - "example": [ - { - "properties": [ - { - "key": "font-size", - "value": "30px" - } - ], - "selector": "th" - } - ], - "properties": { - "properties": { - "description": "List of CSS properties.", - "items": { - "$ref": "#/components/schemas/PdfTableStyleProperty" - }, - "type": "array" - }, - "selector": { - "description": "CSS selector where to apply given properties.", - "type": "string" - } - }, - "required": [ - "selector" - ], - "type": "object" - }, - "PdfTableStyleProperty": { - "description": "CSS property.", - "properties": { - "key": { - "description": "CSS property key.", - "type": "string" - }, - "value": { - "description": "CSS property value.", - "type": "string" - } - }, - "required": [ - "key", - "value" - ], - "type": "object" - }, - "PopDataset": { - "description": "Combination of the date data set to use and how many periods ago to calculate the previous period for.", - "properties": { - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" - }, - "periodsAgo": { - "description": "Number of periods ago to calculate the previous period for.", - "example": 1, - "format": "int32", - "type": "integer" - } - }, - "required": [ - "dataset", - "periodsAgo" - ], - "type": "object" - }, - "PopDatasetMeasureDefinition": { - "description": "Previous period type of metric.", - "properties": { - "previousPeriodMeasure": { - "properties": { - "dateDatasets": { - "description": "Specification of which date data sets to use for determining the period to calculate the previous period for.", - "items": { - "$ref": "#/components/schemas/PopDataset" + "PopDatasetMeasureDefinition" : { + "description" : "Previous period type of metric.", + "properties" : { + "previousPeriodMeasure" : { + "properties" : { + "dateDatasets" : { + "description" : "Specification of which date data sets to use for determining the period to calculate the previous period for.", + "items" : { + "$ref" : "#/components/schemas/PopDataset" }, - "type": "array" + "type" : "array" }, - "measureIdentifier": { - "$ref": "#/components/schemas/AfmLocalIdentifier" + "measureIdentifier" : { + "$ref" : "#/components/schemas/AfmLocalIdentifier" } }, - "required": [ - "dateDatasets", - "measureIdentifier" - ], - "type": "object" - } - }, - "required": [ - "previousPeriodMeasure" - ], - "type": "object" - }, - "PopDate": { - "description": "Combination of the date attribute to use and how many periods ago to calculate the PoP for.", - "properties": { - "attribute": { - "$ref": "#/components/schemas/AfmObjectIdentifierAttribute" - }, - "periodsAgo": { - "description": "Number of periods ago to calculate the previous period for.", - "example": 1, - "format": "int32", - "type": "integer" - } - }, - "required": [ - "attribute", - "periodsAgo" - ], - "type": "object" - }, - "PopDateMeasureDefinition": { - "description": "Period over period type of metric.", - "properties": { - "overPeriodMeasure": { - "properties": { - "dateAttributes": { - "description": "Attributes to use for determining the period to calculate the PoP for.", - "items": { - "$ref": "#/components/schemas/PopDate" + "required" : [ "dateDatasets", "measureIdentifier" ], + "type" : "object" + } + }, + "required" : [ "previousPeriodMeasure" ], + "type" : "object" + }, + "PopDate" : { + "description" : "Combination of the date attribute to use and how many periods ago to calculate the PoP for.", + "properties" : { + "attribute" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierAttribute" + }, + "periodsAgo" : { + "description" : "Number of periods ago to calculate the previous period for.", + "example" : 1, + "format" : "int32", + "type" : "integer" + } + }, + "required" : [ "attribute", "periodsAgo" ], + "type" : "object" + }, + "PopDateMeasureDefinition" : { + "description" : "Period over period type of metric.", + "properties" : { + "overPeriodMeasure" : { + "properties" : { + "dateAttributes" : { + "description" : "Attributes to use for determining the period to calculate the PoP for.", + "items" : { + "$ref" : "#/components/schemas/PopDate" }, - "type": "array" + "type" : "array" }, - "measureIdentifier": { - "$ref": "#/components/schemas/AfmLocalIdentifier" + "measureIdentifier" : { + "$ref" : "#/components/schemas/AfmLocalIdentifier" } }, - "required": [ - "dateAttributes", - "measureIdentifier" - ], - "type": "object" + "required" : [ "dateAttributes", "measureIdentifier" ], + "type" : "object" } }, - "required": [ - "overPeriodMeasure" - ], - "type": "object" + "required" : [ "overPeriodMeasure" ], + "type" : "object" }, - "PopMeasureDefinition": { - "oneOf": [ - { - "$ref": "#/components/schemas/PopDatasetMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopDateMeasureDefinition" - } - ], - "type": "object" + "PopMeasureDefinition" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/PopDatasetMeasureDefinition" + }, { + "$ref" : "#/components/schemas/PopDateMeasureDefinition" + } ], + "type" : "object" }, - "PositiveAttributeFilter": { - "description": "Filter able to limit element values by label and related selected elements.", - "properties": { - "positiveAttributeFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" + "PositiveAttributeFilter" : { + "description" : "Filter able to limit element values by label and related selected elements.", + "properties" : { + "positiveAttributeFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" }, - "in": { - "$ref": "#/components/schemas/AttributeFilterElements" + "in" : { + "$ref" : "#/components/schemas/AttributeFilterElements" }, - "label": { - "$ref": "#/components/schemas/AfmIdentifier" + "label" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "localIdentifier": { - "type": "string" + "localIdentifier" : { + "type" : "string" } }, - "required": [ - "in", - "label" - ], - "type": "object" - } - }, - "required": [ - "positiveAttributeFilter" - ], - "type": "object" - }, - "RangeCondition": { - "description": "Condition that checks if the metric value is within a given range.", - "properties": { - "range": { - "properties": { - "from": { - "example": 100, - "type": "number" - }, - "operator": { - "enum": [ - "BETWEEN", - "NOT_BETWEEN" - ], - "example": "BETWEEN", - "type": "string" - }, - "to": { - "example": 999, - "type": "number" + "required" : [ "in", "label" ], + "type" : "object" + } + }, + "required" : [ "positiveAttributeFilter" ], + "type" : "object" + }, + "RangeCondition" : { + "description" : "Condition that checks if the metric value is within a given range.", + "properties" : { + "range" : { + "properties" : { + "from" : { + "example" : 100, + "type" : "number" + }, + "operator" : { + "enum" : [ "BETWEEN", "NOT_BETWEEN" ], + "example" : "BETWEEN", + "type" : "string" + }, + "to" : { + "example" : 999, + "type" : "number" } }, - "required": [ - "from", - "operator", - "to" - ], - "type": "object" - } - }, - "required": [ - "range" - ], - "type": "object" - }, - "RangeMeasureValueFilter": { - "description": "Filter the result by comparing specified metric to given range of values.", - "properties": { - "rangeMeasureValueFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" + "required" : [ "from", "operator", "to" ], + "type" : "object" + } + }, + "required" : [ "range" ], + "type" : "object" + }, + "RangeMeasureValueFilter" : { + "description" : "Filter the result by comparing specified metric to given range of values.", + "properties" : { + "rangeMeasureValueFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "dimensionality" : { + "description" : "References to the attributes to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "type": "array" - }, - "from": { - "example": 100, - "type": "number" - }, - "localIdentifier": { - "type": "string" - }, - "measure": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "operator": { - "enum": [ - "BETWEEN", - "NOT_BETWEEN" - ], - "example": "BETWEEN", - "type": "string" - }, - "to": { - "example": 999, - "type": "number" - }, - "treatNullValuesAs": { - "description": "A value that will be substituted for null values in the metric for the comparisons.", - "example": 0, - "type": "number" + "type" : "array" + }, + "from" : { + "example" : 100, + "type" : "number" + }, + "localIdentifier" : { + "type" : "string" + }, + "measure" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "operator" : { + "enum" : [ "BETWEEN", "NOT_BETWEEN" ], + "example" : "BETWEEN", + "type" : "string" + }, + "to" : { + "example" : 999, + "type" : "number" + }, + "treatNullValuesAs" : { + "description" : "A value that will be substituted for null values in the metric for the comparisons.", + "example" : 0, + "type" : "number" } }, - "required": [ - "from", - "operator", - "to", - "measure" - ], - "type": "object" - } - }, - "required": [ - "rangeMeasureValueFilter" - ], - "type": "object" - }, - "RankingFilter": { - "description": "Filter the result on top/bottom N values according to given metric(s).", - "properties": { - "rankingFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" + "required" : [ "from", "operator", "to", "measure" ], + "type" : "object" + } + }, + "required" : [ "rangeMeasureValueFilter" ], + "type" : "object" + }, + "RankingFilter" : { + "description" : "Filter the result on top/bottom N values according to given metric(s).", + "properties" : { + "rankingFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "dimensionality" : { + "description" : "References to the attributes to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "type": "array" + "type" : "array" }, - "localIdentifier": { - "type": "string" + "localIdentifier" : { + "type" : "string" }, - "measures": { - "description": "References to the metrics to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" + "measures" : { + "description" : "References to the metrics to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - "type": "array" - }, - "operator": { - "description": "The type of ranking to use, TOP or BOTTOM.", - "enum": [ - "TOP", - "BOTTOM" - ], - "type": "string" - }, - "value": { - "description": "Number of top/bottom values to filter.", - "example": 5, - "format": "int32", - "type": "integer" + "type" : "array" + }, + "operator" : { + "description" : "The type of ranking to use, TOP or BOTTOM.", + "enum" : [ "TOP", "BOTTOM" ], + "type" : "string" + }, + "value" : { + "description" : "Number of top/bottom values to filter.", + "example" : 5, + "format" : "int32", + "type" : "integer" } }, - "required": [ - "measures", - "operator", - "value" - ], - "type": "object" - } - }, - "required": [ - "rankingFilter" - ], - "type": "object" - }, - "RawCustomLabel": { - "description": "Custom label object override.", - "properties": { - "title": { - "description": "Override value.", - "type": "string" - } - }, - "required": [ - "title" - ], - "type": "object" - }, - "RawCustomMetric": { - "description": "Custom metric object override.", - "properties": { - "title": { - "description": "Metric title override.", - "type": "string" - } - }, - "required": [ - "title" - ], - "type": "object" - }, - "RawCustomOverride": { - "description": "Custom cell value overrides (IDs will be replaced with specified values).", - "properties": { - "labels": { - "additionalProperties": { - "$ref": "#/components/schemas/RawCustomLabel" - }, - "description": "Map of CustomLabels with keys used as placeholders in export result.", - "type": "object" - }, - "metrics": { - "additionalProperties": { - "$ref": "#/components/schemas/RawCustomMetric" - }, - "description": "Map of CustomMetrics with keys used as placeholders in export result.", - "type": "object" - } - }, - "type": "object" - }, - "RawExportRequest": { - "description": "Export request object describing the export properties and overrides for raw exports.", - "properties": { - "customOverride": { - "$ref": "#/components/schemas/RawCustomOverride" - }, - "delimiter": { - "description": "Set column delimiter. (CSV)", - "maxLength": 1, - "minLength": 1, - "pattern": "^[^\\r\\n\"]$", - "type": "string" - }, - "execution": { - "$ref": "#/components/schemas/AFM" - }, - "executionSettings": { - "$ref": "#/components/schemas/ExecutionSettings" - }, - "fileName": { - "description": "Filename of downloaded file without extension.", - "example": "result", - "type": "string" - }, - "format": { - "description": "Requested resulting file type.", - "enum": [ - "ARROW_FILE", - "ARROW_STREAM", - "CSV" - ], - "example": "CSV", - "type": "string" - } - }, - "required": [ - "execution", - "fileName", - "format" - ], - "type": "object" - }, - "RelativeBoundedDateFilter": { - "properties": { - "from": { - "format": "int32", - "type": "integer" - }, - "granularity": { - "enum": [ - "ALL_TIME_GRANULARITY", - "GDC.time.year", - "GDC.time.week_us", - "GDC.time.week_in_year", - "GDC.time.week_in_quarter", - "GDC.time.week", - "GDC.time.euweek_in_year", - "GDC.time.euweek_in_quarter", - "GDC.time.quarter", - "GDC.time.quarter_in_year", - "GDC.time.month", - "GDC.time.month_in_quarter", - "GDC.time.month_in_year", - "GDC.time.day_in_year", - "GDC.time.day_in_quarter", - "GDC.time.day_in_month", - "GDC.time.day_in_week", - "GDC.time.day_in_euweek", - "GDC.time.date", - "GDC.time.hour", - "GDC.time.hour_in_day", - "GDC.time.minute", - "GDC.time.minute_in_hour", - "GDC.time.fiscal_month", - "GDC.time.fiscal_quarter", - "GDC.time.fiscal_year" - ], - "type": "string" - }, - "to": { - "format": "int32", - "type": "integer" - } - }, - "required": [ - "granularity" - ], - "type": "object" - }, - "RelativeDateFilter": { - "description": "A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both.", - "properties": { - "relativeDateFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "boundedFilter": { - "$ref": "#/components/schemas/BoundedFilter" - }, - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" - }, - "from": { - "description": "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago').", - "example": -6, - "format": "int32", - "type": "integer" - }, - "granularity": { - "description": "Date granularity specifying particular date attribute in given dimension.", - "enum": [ - "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", - "MINUTE_OF_HOUR", - "HOUR_OF_DAY", - "DAY_OF_WEEK", - "DAY_OF_MONTH", - "DAY_OF_QUARTER", - "DAY_OF_YEAR", - "WEEK_OF_YEAR", - "MONTH_OF_YEAR", - "QUARTER_OF_YEAR", - "FISCAL_MONTH", - "FISCAL_QUARTER", - "FISCAL_YEAR" - ], - "example": "DAY", - "type": "string" - }, - "includeEmptyValues": { - "description": "If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).", - "type": "boolean" - }, - "localIdentifier": { - "type": "string" - }, - "to": { - "description": "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...).", - "example": 0, - "format": "int32", - "type": "integer" - } + "required" : [ "measures", "operator", "value" ], + "type" : "object" + } + }, + "required" : [ "rankingFilter" ], + "type" : "object" + }, + "RawCustomLabel" : { + "description" : "Custom label object override.", + "properties" : { + "title" : { + "description" : "Override value.", + "type" : "string" + } + }, + "required" : [ "title" ], + "type" : "object" + }, + "RawCustomMetric" : { + "description" : "Custom metric object override.", + "properties" : { + "title" : { + "description" : "Metric title override.", + "type" : "string" + } + }, + "required" : [ "title" ], + "type" : "object" + }, + "RawCustomOverride" : { + "description" : "Custom cell value overrides (IDs will be replaced with specified values).", + "properties" : { + "labels" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/RawCustomLabel" + }, + "description" : "Map of CustomLabels with keys used as placeholders in export result.", + "type" : "object" + }, + "metrics" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/RawCustomMetric" }, - "required": [ - "from", - "granularity", - "to", - "dataset" - ], - "type": "object" - } - }, - "required": [ - "relativeDateFilter" - ], - "type": "object" - }, - "Settings": { - "description": "Additional settings.", - "properties": { - "delimiter": { - "description": "Set column delimiter. (CSV)", - "maxLength": 1, - "minLength": 1, - "pattern": "^[^\\r\\n\"]$", - "type": "string" - }, - "exportInfo": { - "default": false, - "description": "If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF)", - "example": true, - "type": "boolean" - }, - "mergeHeaders": { - "description": "Merge equal headers in neighbouring cells. (XLSX)", - "example": true, - "type": "boolean" - }, - "pageOrientation": { - "default": "PORTRAIT", - "description": "Set page orientation. (PDF)", - "enum": [ - "PORTRAIT", - "LANDSCAPE" - ], - "type": "string" - }, - "pageSize": { - "default": "A4", - "description": "Set page size. (PDF)", - "enum": [ - "A3", - "A4", - "LETTER" - ], - "type": "string" - }, - "pdfPageSize": { - "deprecated": true, - "description": "Page size and orientation. (PDF)", - "example": "a4 landscape", - "type": "string" - }, - "pdfTableStyle": { - "deprecated": true, - "description": "Custom CSS styles for the table. (PDF, HTML)", - "example": [ - { - "properties": [ - { - "key": "font-size", - "value": "30px" - } - ], - "selector": "th" + "description" : "Map of CustomMetrics with keys used as placeholders in export result.", + "type" : "object" + } + }, + "type" : "object" + }, + "RawExportRequest" : { + "description" : "Export request object describing the export properties and overrides for raw exports.", + "properties" : { + "customOverride" : { + "$ref" : "#/components/schemas/RawCustomOverride" + }, + "delimiter" : { + "description" : "Set column delimiter. (CSV)", + "maxLength" : 1, + "minLength" : 1, + "pattern" : "^[^\\r\\n\"]$", + "type" : "string" + }, + "execution" : { + "$ref" : "#/components/schemas/AFM" + }, + "executionSettings" : { + "$ref" : "#/components/schemas/ExecutionSettings" + }, + "fileName" : { + "description" : "Filename of downloaded file without extension.", + "example" : "result", + "type" : "string" + }, + "format" : { + "description" : "Requested resulting file type.", + "enum" : [ "ARROW_FILE", "ARROW_STREAM", "CSV" ], + "example" : "CSV", + "type" : "string" + } + }, + "required" : [ "execution", "fileName", "format" ], + "type" : "object" + }, + "RelativeBoundedDateFilter" : { + "properties" : { + "from" : { + "format" : "int32", + "type" : "integer" + }, + "granularity" : { + "enum" : [ "ALL_TIME_GRANULARITY", "GDC.time.year", "GDC.time.week_us", "GDC.time.week_in_year", "GDC.time.week_in_quarter", "GDC.time.week", "GDC.time.euweek_in_year", "GDC.time.euweek_in_quarter", "GDC.time.quarter", "GDC.time.quarter_in_year", "GDC.time.month", "GDC.time.month_in_quarter", "GDC.time.month_in_year", "GDC.time.day_in_year", "GDC.time.day_in_quarter", "GDC.time.day_in_month", "GDC.time.day_in_week", "GDC.time.day_in_euweek", "GDC.time.date", "GDC.time.hour", "GDC.time.hour_in_day", "GDC.time.minute", "GDC.time.minute_in_hour", "GDC.time.fiscal_month", "GDC.time.fiscal_quarter", "GDC.time.fiscal_year" ], + "type" : "string" + }, + "to" : { + "format" : "int32", + "type" : "integer" + } + }, + "required" : [ "granularity" ], + "type" : "object" + }, + "RelativeDateFilter" : { + "description" : "A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both.", + "properties" : { + "relativeDateFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "boundedFilter" : { + "$ref" : "#/components/schemas/BoundedFilter" + }, + "dataset" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierDataset" + }, + "from" : { + "description" : "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago').", + "example" : -6, + "format" : "int32", + "type" : "integer" + }, + "granularity" : { + "description" : "Date granularity specifying particular date attribute in given dimension.", + "enum" : [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], + "example" : "DAY", + "type" : "string" + }, + "localIdentifier" : { + "type" : "string" + }, + "to" : { + "description" : "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...).", + "example" : 0, + "format" : "int32", + "type" : "integer" } - ], - "items": { - "$ref": "#/components/schemas/PdfTableStyle" - }, - "type": "array" - }, - "pdfTopLeftContent": { - "deprecated": true, - "description": "Top left header content. (PDF)", - "example": "Good", - "type": "string" - }, - "pdfTopRightContent": { - "deprecated": true, - "description": "Top right header content. (PDF)", - "example": "Morning", - "type": "string" - }, - "showFilters": { - "deprecated": true, - "description": "Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)", - "example": false, - "type": "boolean" - } - }, - "type": "object" - }, - "SimpleMeasureDefinition": { - "description": "Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.", - "properties": { - "measure": { - "properties": { - "aggregation": { - "description": "Definition of aggregation type of the metric.", - "enum": [ - "SUM", - "COUNT", - "AVG", - "MIN", - "MAX", - "MEDIAN", - "RUNSUM", - "APPROXIMATE_COUNT" - ], - "example": "SUM", - "type": "string" - }, - "computeRatio": { - "default": false, - "description": "If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).", - "example": true, - "type": "boolean" - }, - "filters": { - "description": "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.", - "items": { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" + }, + "required" : [ "from", "granularity", "to", "dataset" ], + "type" : "object" + } + }, + "required" : [ "relativeDateFilter" ], + "type" : "object" + }, + "Settings" : { + "description" : "Additional settings.", + "properties" : { + "delimiter" : { + "description" : "Set column delimiter. (CSV)", + "maxLength" : 1, + "minLength" : 1, + "pattern" : "^[^\\r\\n\"]$", + "type" : "string" + }, + "exportInfo" : { + "default" : false, + "description" : "If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF)", + "example" : true, + "type" : "boolean" + }, + "mergeHeaders" : { + "description" : "Merge equal headers in neighbouring cells. (XLSX)", + "example" : true, + "type" : "boolean" + }, + "pageOrientation" : { + "default" : "PORTRAIT", + "description" : "Set page orientation. (PDF)", + "enum" : [ "PORTRAIT", "LANDSCAPE" ], + "type" : "string" + }, + "pageSize" : { + "default" : "A4", + "description" : "Set page size. (PDF)", + "enum" : [ "A3", "A4", "LETTER" ], + "type" : "string" + }, + "pdfPageSize" : { + "deprecated" : true, + "description" : "Page size and orientation. (PDF)", + "example" : "a4 landscape", + "type" : "string" + }, + "pdfTableStyle" : { + "deprecated" : true, + "description" : "Custom CSS styles for the table. (PDF, HTML)", + "example" : [ { + "properties" : [ { + "key" : "font-size", + "value" : "30px" + } ], + "selector" : "th" + } ], + "items" : { + "$ref" : "#/components/schemas/PdfTableStyle" + }, + "type" : "array" + }, + "pdfTopLeftContent" : { + "deprecated" : true, + "description" : "Top left header content. (PDF)", + "example" : "Good", + "type" : "string" + }, + "pdfTopRightContent" : { + "deprecated" : true, + "description" : "Top right header content. (PDF)", + "example" : "Morning", + "type" : "string" + }, + "showFilters" : { + "deprecated" : true, + "description" : "Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)", + "example" : false, + "type" : "boolean" + } + }, + "type" : "object" + }, + "SimpleMeasureDefinition" : { + "description" : "Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.", + "properties" : { + "measure" : { + "properties" : { + "aggregation" : { + "description" : "Definition of aggregation type of the metric.", + "enum" : [ "SUM", "COUNT", "AVG", "MIN", "MAX", "MEDIAN", "RUNSUM", "APPROXIMATE_COUNT" ], + "example" : "SUM", + "type" : "string" + }, + "computeRatio" : { + "default" : false, + "description" : "If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).", + "example" : true, + "type" : "boolean" + }, + "filters" : { + "description" : "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.", + "items" : { + "$ref" : "#/components/schemas/FilterDefinitionForSimpleMeasure" }, - "type": "array" + "type" : "array" }, - "item": { - "$ref": "#/components/schemas/AfmObjectIdentifierCore" + "item" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierCore" } }, - "required": [ - "item" - ], - "type": "object" - } - }, - "required": [ - "measure" - ], - "type": "object" - }, - "SlidesExportRequest": { - "description": "Export request object describing the export properties and metadata for slides exports.", - "properties": { - "dashboardId": { - "description": "Dashboard identifier", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - "type": "string" - }, - "fileName": { - "description": "File name to be used for retrieving the pdf document.", - "example": "filename", - "type": "string" - }, - "format": { - "description": "Requested resulting file type.", - "enum": [ - "PDF", - "PPTX" - ], - "example": "PDF", - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/JsonNode" - }, - "templateId": { - "description": "Export template identifier.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "visualizationIds": { - "description": "List of visualization ids to be exported. Note that only one visualization is currently supported.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true - }, - "widgetIds": { - "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "fileName", - "format" - ], - "type": "object" - }, - "TabularExportRequest": { - "description": "Export request object describing the export properties and overrides for tabular exports.", - "properties": { - "customOverride": { - "$ref": "#/components/schemas/CustomOverride" - }, - "executionResult": { - "description": "Execution result identifier.", - "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", - "type": "string" - }, - "fileName": { - "description": "Filename of downloaded file without extension.", - "example": "result", - "type": "string" - }, - "format": { - "description": "Expected file format.", - "enum": [ - "CSV", - "XLSX", - "HTML", - "PDF" - ], - "example": "CSV", - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/JsonNode" - }, - "relatedDashboardId": { - "description": "Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - "type": "string" - }, - "settings": { - "$ref": "#/components/schemas/Settings" - }, - "visualizationObject": { - "description": "Visualization object identifier. Alternative to executionResult property.", - "example": "f7c359bc-c230-4487-b15b-ad9685bcb537", - "type": "string" - }, - "visualizationObjectCustomFilters": { - "description": "Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.", - "example": "[{\"negativeAttributeFilter\":{\"displayForm\":{\"identifier\":{\"id\":\"products.category\",\"type\":\"label\"}},\"notIn\":{\"values\":[\"Books\"]}}}]", - "items": { - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "fileName", - "format" - ], - "type": "object" - }, - "VisualExportRequest": { - "description": "Export request object describing the export properties and metadata for dashboard PDF exports.", - "properties": { - "dashboardId": { - "description": "Dashboard identifier", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - "type": "string" - }, - "fileName": { - "description": "File name to be used for retrieving the pdf document.", - "example": "filename", - "type": "string" - }, - "metadata": { - "description": "Metadata definition in free-form JSON format.", - "example": "{}", - "type": "object" - } - }, - "required": [ - "dashboardId", - "fileName" - ], - "type": "object" + "required" : [ "item" ], + "type" : "object" + } + }, + "required" : [ "measure" ], + "type" : "object" + }, + "SlidesExportRequest" : { + "description" : "Export request object describing the export properties and metadata for slides exports.", + "properties" : { + "dashboardId" : { + "description" : "Dashboard identifier", + "example" : "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type" : "string" + }, + "fileName" : { + "description" : "File name to be used for retrieving the pdf document.", + "example" : "filename", + "type" : "string" + }, + "format" : { + "description" : "Requested resulting file type.", + "enum" : [ "PDF", "PPTX" ], + "example" : "PDF", + "type" : "string" + }, + "metadata" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "templateId" : { + "description" : "Export template identifier.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "visualizationIds" : { + "description" : "List of visualization ids to be exported. Note that only one visualization is currently supported.", + "items" : { + "maxLength" : 255, + "minLength" : 1, + "type" : "string" + }, + "maxItems" : 1, + "type" : "array", + "uniqueItems" : true + }, + "widgetIds" : { + "description" : "List of widget identifiers to be exported. Note that only one widget is currently supported.", + "items" : { + "maxLength" : 255, + "minLength" : 1, + "type" : "string" + }, + "maxItems" : 1, + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "fileName", "format" ], + "type" : "object" + }, + "TabularExportRequest" : { + "description" : "Export request object describing the export properties and overrides for tabular exports.", + "properties" : { + "customOverride" : { + "$ref" : "#/components/schemas/CustomOverride" + }, + "executionResult" : { + "description" : "Execution result identifier.", + "example" : "ff483727196c9dc862c7fd3a5a84df55c96d61a4", + "type" : "string" + }, + "fileName" : { + "description" : "Filename of downloaded file without extension.", + "example" : "result", + "type" : "string" + }, + "format" : { + "description" : "Expected file format.", + "enum" : [ "CSV", "XLSX", "HTML", "PDF" ], + "example" : "CSV", + "type" : "string" + }, + "metadata" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "relatedDashboardId" : { + "description" : "Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.", + "example" : "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type" : "string" + }, + "settings" : { + "$ref" : "#/components/schemas/Settings" + }, + "visualizationObject" : { + "description" : "Visualization object identifier. Alternative to executionResult property.", + "example" : "f7c359bc-c230-4487-b15b-ad9685bcb537", + "type" : "string" + }, + "visualizationObjectCustomFilters" : { + "description" : "Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.", + "example" : "[{\"negativeAttributeFilter\":{\"displayForm\":{\"identifier\":{\"id\":\"products.category\",\"type\":\"label\"}},\"notIn\":{\"values\":[\"Books\"]}}}]", + "items" : { + "type" : "object" + }, + "type" : "array" + } + }, + "required" : [ "fileName", "format" ], + "type" : "object" + }, + "VisualExportRequest" : { + "description" : "Export request object describing the export properties and metadata for dashboard PDF exports.", + "properties" : { + "dashboardId" : { + "description" : "Dashboard identifier", + "example" : "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type" : "string" + }, + "fileName" : { + "description" : "File name to be used for retrieving the pdf document.", + "example" : "filename", + "type" : "string" + }, + "metadata" : { + "description" : "Metadata definition in free-form JSON format.", + "example" : "{}", + "type" : "object" + } + }, + "required" : [ "dashboardId", "fileName" ], + "type" : "object" } } }, - "info": { - "title": "OpenAPI definition", - "version": "v0" + "info" : { + "title" : "OpenAPI definition", + "version" : "v0" }, - "openapi": "3.0.1", - "paths": { - "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular": { - "post": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", - "operationId": "createDashboardExportRequest", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "dashboardId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DashboardTabularExportRequest" + "openapi" : "3.0.1", + "paths" : { + "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular" : { + "post" : { + "description" : "Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", + "operationId" : "createDashboardExportRequest", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "dashboardId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DashboardTabularExportRequest" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExportResponse" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ExportResponse" } } }, - "description": "Tabular export request created successfully." + "description" : "Tabular export request created successfully." } }, - "summary": "(EXPERIMENTAL) Create dashboard tabular export request", - "tags": [ - "Tabular export", - "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to execute tabular export.", - "permissions": [ - "EXPORT_TABULAR" - ] + "summary" : "(EXPERIMENTAL) Create dashboard tabular export request", + "tags" : [ "Tabular export", "actions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to execute tabular export.", + "permissions" : [ "EXPORT_TABULAR" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/image": { - "post": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", - "operationId": "createImageExport", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImageExportRequest" + "/api/v1/actions/workspaces/{workspaceId}/export/image" : { + "post" : { + "description" : "Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", + "operationId" : "createImageExport", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ImageExportRequest" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExportResponse" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ExportResponse" } } }, - "description": "Image export request created successfully." + "description" : "Image export request created successfully." } }, - "summary": "(EXPERIMENTAL) Create image export request", - "tags": [ - "Image export", - "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to execute image export.", - "permissions": [ - "EXPORT_PDF" - ] + "summary" : "(EXPERIMENTAL) Create image export request", + "tags" : [ "Image export", "actions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to execute image export.", + "permissions" : [ "EXPORT_PDF" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}": { - "get": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", - "operationId": "getImageExport", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "exportId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "image/png": { - "schema": { - "format": "binary", - "type": "string" + "/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}" : { + "get" : { + "description" : "Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", + "operationId" : "getImageExport", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "image/png" : { + "schema" : { + "format" : "binary", + "type" : "string" } } }, - "description": "Binary export result.", - "headers": { - "Content-Disposition": { - "schema": { - "example": "attachment; filename='result.png'", - "pattern": "attachment; filename='[^']+'", - "type": "string" + "description" : "Binary export result.", + "headers" : { + "Content-Disposition" : { + "schema" : { + "example" : "attachment; filename='result.png'", + "pattern" : "attachment; filename='[^']+'", + "type" : "string" }, - "style": "simple" + "style" : "simple" } } }, - "202": { - "content": { - "image/png": { - "schema": { - "items": { - "properties": { - "char": { - "type": "string" + "202" : { + "content" : { + "image/png" : { + "schema" : { + "items" : { + "properties" : { + "char" : { + "type" : "string" }, - "direct": { - "type": "boolean" + "direct" : { + "type" : "boolean" }, - "double": { - "format": "double", - "type": "number" + "double" : { + "format" : "double", + "type" : "number" }, - "float": { - "format": "float", - "type": "number" + "float" : { + "format" : "float", + "type" : "number" }, - "int": { - "format": "int32", - "type": "integer" + "int" : { + "format" : "int32", + "type" : "integer" }, - "long": { - "format": "int64", - "type": "integer" + "long" : { + "format" : "int64", + "type" : "integer" }, - "readOnly": { - "type": "boolean" + "readOnly" : { + "type" : "boolean" }, - "short": { - "format": "int32", - "type": "integer" + "short" : { + "format" : "int32", + "type" : "integer" } }, - "type": "object" + "type" : "object" }, - "type": "array" + "type" : "array" } } }, - "description": "Request is accepted, provided exportId exists, but export is not yet ready." + "description" : "Request is accepted, provided exportId exists, but export is not yet ready." } }, - "summary": "(EXPERIMENTAL) Retrieve exported files", - "tags": [ - "Image export", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "EXPORT_PDF" - ] + "summary" : "(EXPERIMENTAL) Retrieve exported files", + "tags" : [ "Image export", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "EXPORT_PDF" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}/metadata": { - "get": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/image endpoint. The metadata structure is not verified.", - "operationId": "getImageExportMetadata", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "exportId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": {} - }, - "description": "Json metadata representation" - } - }, - "summary": "(EXPERIMENTAL) Retrieve metadata context", - "tags": [ - "Image export", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "EXPORT_PDF" - ] + "/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}/metadata" : { + "get" : { + "description" : "Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/image endpoint. The metadata structure is not verified.", + "operationId" : "getImageExportMetadata", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { } + }, + "description" : "Json metadata representation" + } + }, + "summary" : "(EXPERIMENTAL) Retrieve metadata context", + "tags" : [ "Image export", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "EXPORT_PDF" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/raw": { - "post": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", - "operationId": "createRawExport", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RawExportRequest" + "/api/v1/actions/workspaces/{workspaceId}/export/raw" : { + "post" : { + "description" : "Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", + "operationId" : "createRawExport", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RawExportRequest" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExportResponse" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ExportResponse" } } }, - "description": "Raw export request created successfully." + "description" : "Raw export request created successfully." } }, - "summary": "(EXPERIMENTAL) Create raw export request", - "tags": [ - "Raw export", - "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to execute raw export.", - "permissions": [ - "EXPORT_TABULAR" - ] + "summary" : "(EXPERIMENTAL) Create raw export request", + "tags" : [ "Raw export", "actions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to execute raw export.", + "permissions" : [ "EXPORT_TABULAR" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}": { - "get": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", - "operationId": "getRawExport", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "exportId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/vnd.apache.arrow.file": { - "schema": { - "format": "binary", - "type": "string" + "/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}" : { + "get" : { + "description" : "Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", + "operationId" : "getRawExport", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.apache.arrow.file" : { + "schema" : { + "format" : "binary", + "type" : "string" } }, - "application/vnd.apache.arrow.stream": { - "schema": { - "format": "binary", - "type": "string" + "application/vnd.apache.arrow.stream" : { + "schema" : { + "format" : "binary", + "type" : "string" } }, - "text/csv": { - "schema": { - "format": "binary", - "type": "string" + "text/csv" : { + "schema" : { + "format" : "binary", + "type" : "string" } } }, - "description": "Binary export result.", - "headers": { - "Content-Disposition": { - "schema": { - "example": "attachment; filename='result.csv'", - "pattern": "attachment; filename='[^']+'", - "type": "string" + "description" : "Binary export result.", + "headers" : { + "Content-Disposition" : { + "schema" : { + "example" : "attachment; filename='result.csv'", + "pattern" : "attachment; filename='[^']+'", + "type" : "string" }, - "style": "simple" + "style" : "simple" } } }, - "202": { - "content": { - "application/vnd.apache.arrow.file": { - "schema": { - "format": "binary", - "type": "string" + "202" : { + "content" : { + "application/vnd.apache.arrow.file" : { + "schema" : { + "format" : "binary", + "type" : "string" } }, - "application/vnd.apache.arrow.stream": { - "schema": { - "format": "binary", - "type": "string" + "application/vnd.apache.arrow.stream" : { + "schema" : { + "format" : "binary", + "type" : "string" } }, - "text/csv": { - "schema": { - "format": "binary", - "type": "string" + "text/csv" : { + "schema" : { + "format" : "binary", + "type" : "string" } } }, - "description": "Request is accepted, provided exportId exists, but export is not yet ready." + "description" : "Request is accepted, provided exportId exists, but export is not yet ready." } }, - "summary": "(EXPERIMENTAL) Retrieve exported files", - "tags": [ - "Raw export", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "EXPORT_TABULAR" - ] + "summary" : "(EXPERIMENTAL) Retrieve exported files", + "tags" : [ "Raw export", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "EXPORT_TABULAR" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/slides": { - "post": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", - "operationId": "createSlidesExport", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "X-Gdc-Debug", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SlidesExportRequest" + "/api/v1/actions/workspaces/{workspaceId}/export/slides" : { + "post" : { + "description" : "Note: This API is an experimental and is going to change. Please, use it accordingly. A slides export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", + "operationId" : "createSlidesExport", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-Gdc-Debug", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SlidesExportRequest" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExportResponse" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ExportResponse" } } }, - "description": "Slides export request created successfully." + "description" : "Slides export request created successfully." } }, - "summary": "(EXPERIMENTAL) Create slides export request", - "tags": [ - "Slides export", - "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to execute slides export.", - "permissions": [ - "EXPORT_PDF" - ] + "summary" : "(EXPERIMENTAL) Create slides export request", + "tags" : [ "Slides export", "actions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to execute slides export.", + "permissions" : [ "EXPORT_PDF" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}": { - "get": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", - "operationId": "getSlidesExport", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "exportId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/pdf": { - "schema": { - "format": "binary", - "type": "string" + "/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}" : { + "get" : { + "description" : "Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", + "operationId" : "getSlidesExport", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/pdf" : { + "schema" : { + "format" : "binary", + "type" : "string" } }, - "application/vnd.openxmlformats-officedocument.presentationml.presentation": { - "schema": { - "format": "binary", - "type": "string" + "application/vnd.openxmlformats-officedocument.presentationml.presentation" : { + "schema" : { + "format" : "binary", + "type" : "string" } }, - "application/zip": { - "schema": { - "format": "binary", - "type": "string" + "application/zip" : { + "schema" : { + "format" : "binary", + "type" : "string" } } }, - "description": "Binary export result.", - "headers": { - "Content-Disposition": { - "schema": { - "example": "attachment; filename='result.pdf'", - "pattern": "attachment; filename='[^']+'", - "type": "string" + "description" : "Binary export result.", + "headers" : { + "Content-Disposition" : { + "schema" : { + "example" : "attachment; filename='result.pdf'", + "pattern" : "attachment; filename='[^']+'", + "type" : "string" }, - "style": "simple" + "style" : "simple" } } }, - "202": { - "content": { - "application/pdf": { - "schema": { - "items": { - "properties": { - "char": { - "type": "string" + "202" : { + "content" : { + "application/pdf" : { + "schema" : { + "items" : { + "properties" : { + "char" : { + "type" : "string" }, - "direct": { - "type": "boolean" + "direct" : { + "type" : "boolean" }, - "double": { - "format": "double", - "type": "number" + "double" : { + "format" : "double", + "type" : "number" }, - "float": { - "format": "float", - "type": "number" + "float" : { + "format" : "float", + "type" : "number" }, - "int": { - "format": "int32", - "type": "integer" + "int" : { + "format" : "int32", + "type" : "integer" }, - "long": { - "format": "int64", - "type": "integer" + "long" : { + "format" : "int64", + "type" : "integer" }, - "readOnly": { - "type": "boolean" + "readOnly" : { + "type" : "boolean" }, - "short": { - "format": "int32", - "type": "integer" + "short" : { + "format" : "int32", + "type" : "integer" } }, - "type": "object" + "type" : "object" }, - "type": "array" + "type" : "array" } }, - "application/vnd.openxmlformats-officedocument.presentationml.presentation": { - "schema": { - "items": { - "properties": { - "char": { - "type": "string" + "application/vnd.openxmlformats-officedocument.presentationml.presentation" : { + "schema" : { + "items" : { + "properties" : { + "char" : { + "type" : "string" }, - "direct": { - "type": "boolean" + "direct" : { + "type" : "boolean" }, - "double": { - "format": "double", - "type": "number" + "double" : { + "format" : "double", + "type" : "number" }, - "float": { - "format": "float", - "type": "number" + "float" : { + "format" : "float", + "type" : "number" }, - "int": { - "format": "int32", - "type": "integer" + "int" : { + "format" : "int32", + "type" : "integer" }, - "long": { - "format": "int64", - "type": "integer" + "long" : { + "format" : "int64", + "type" : "integer" }, - "readOnly": { - "type": "boolean" + "readOnly" : { + "type" : "boolean" }, - "short": { - "format": "int32", - "type": "integer" + "short" : { + "format" : "int32", + "type" : "integer" } }, - "type": "object" + "type" : "object" }, - "type": "array" + "type" : "array" } } }, - "description": "Request is accepted, provided exportId exists, but export is not yet ready." + "description" : "Request is accepted, provided exportId exists, but export is not yet ready." } }, - "summary": "(EXPERIMENTAL) Retrieve exported files", - "tags": [ - "Slides export", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "EXPORT_PDF" - ] + "summary" : "(EXPERIMENTAL) Retrieve exported files", + "tags" : [ "Slides export", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "EXPORT_PDF" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}/metadata": { - "get": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/slides endpoint. The metadata structure is not verified.", - "operationId": "getSlidesExportMetadata", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "exportId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": {} - }, - "description": "Json metadata representation" - } - }, - "summary": "(EXPERIMENTAL) Retrieve metadata context", - "tags": [ - "Slides export", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "EXPORT_PDF" - ] + "/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}/metadata" : { + "get" : { + "description" : "Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/slides endpoint. The metadata structure is not verified.", + "operationId" : "getSlidesExportMetadata", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { } + }, + "description" : "Json metadata representation" + } + }, + "summary" : "(EXPERIMENTAL) Retrieve metadata context", + "tags" : [ "Slides export", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "EXPORT_PDF" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/tabular": { - "post": { - "description": "An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", - "operationId": "createTabularExport", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TabularExportRequest" + "/api/v1/actions/workspaces/{workspaceId}/export/tabular" : { + "post" : { + "description" : "An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", + "operationId" : "createTabularExport", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TabularExportRequest" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExportResponse" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ExportResponse" } } }, - "description": "Tabular export request created successfully." + "description" : "Tabular export request created successfully." } }, - "summary": "Create tabular export request", - "tags": [ - "Tabular export", - "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to execute tabular export.", - "permissions": [ - "EXPORT_TABULAR" - ] + "summary" : "Create tabular export request", + "tags" : [ "Tabular export", "actions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to execute tabular export.", + "permissions" : [ "EXPORT_TABULAR" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId}": { - "get": { - "description": "After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", - "operationId": "getTabularExport", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "exportId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/pdf": { - "schema": { - "format": "binary", - "type": "string" + "/api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId}" : { + "get" : { + "description" : "After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", + "operationId" : "getTabularExport", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/pdf" : { + "schema" : { + "format" : "binary", + "type" : "string" } }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "format": "binary", - "type": "string" + "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" : { + "schema" : { + "format" : "binary", + "type" : "string" } }, - "application/zip": { - "schema": { - "format": "binary", - "type": "string" + "application/zip" : { + "schema" : { + "format" : "binary", + "type" : "string" } }, - "text/csv": { - "schema": { - "format": "binary", - "type": "string" + "text/csv" : { + "schema" : { + "format" : "binary", + "type" : "string" } }, - "text/html": { - "schema": { - "format": "binary", - "type": "string" + "text/html" : { + "schema" : { + "format" : "binary", + "type" : "string" } } }, - "description": "Binary export result.", - "headers": { - "Content-Disposition": { - "schema": { - "example": "attachment; filename='result.csv'", - "pattern": "attachment; filename='[^']+'", - "type": "string" + "description" : "Binary export result.", + "headers" : { + "Content-Disposition" : { + "schema" : { + "example" : "attachment; filename='result.csv'", + "pattern" : "attachment; filename='[^']+'", + "type" : "string" }, - "style": "simple" + "style" : "simple" } } }, - "202": { - "content": { - "application/pdf": { - "schema": { - "format": "binary", - "type": "string" + "202" : { + "content" : { + "application/pdf" : { + "schema" : { + "format" : "binary", + "type" : "string" } }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "format": "binary", - "type": "string" + "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" : { + "schema" : { + "format" : "binary", + "type" : "string" } }, - "application/zip": { - "schema": { - "format": "binary", - "type": "string" + "application/zip" : { + "schema" : { + "format" : "binary", + "type" : "string" } }, - "text/csv": { - "schema": { - "format": "binary", - "type": "string" + "text/csv" : { + "schema" : { + "format" : "binary", + "type" : "string" } }, - "text/html": { - "schema": { - "format": "binary", - "type": "string" + "text/html" : { + "schema" : { + "format" : "binary", + "type" : "string" } } }, - "description": "Request is accepted, provided exportId exists, but export is not yet ready." + "description" : "Request is accepted, provided exportId exists, but export is not yet ready." } }, - "summary": "Retrieve exported files", - "tags": [ - "Tabular export", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "EXPORT_TABULAR" - ] + "summary" : "Retrieve exported files", + "tags" : [ "Tabular export", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "EXPORT_TABULAR" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/visual": { - "post": { - "description": "An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", - "operationId": "createPdfExport", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "X-Gdc-Debug", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VisualExportRequest" + "/api/v1/actions/workspaces/{workspaceId}/export/visual" : { + "post" : { + "description" : "An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", + "operationId" : "createPdfExport", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-Gdc-Debug", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VisualExportRequest" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExportResponse" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ExportResponse" } } }, - "description": "Visual export request created successfully." + "description" : "Visual export request created successfully." } }, - "summary": "Create visual - pdf export request", - "tags": [ - "actions", - "Visual export" - ], - "x-gdc-security-info": { - "description": "Permissions required to execute pdf export.", - "permissions": [ - "EXPORT_PDF" - ] + "summary" : "Create visual - pdf export request", + "tags" : [ "actions", "Visual export" ], + "x-gdc-security-info" : { + "description" : "Permissions required to execute pdf export.", + "permissions" : [ "EXPORT_PDF" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}": { - "get": { - "description": "Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.", - "operationId": "getExportedFile", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "exportId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/pdf": { - "schema": { - "format": "binary", - "type": "string" + "/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}" : { + "get" : { + "description" : "Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.", + "operationId" : "getExportedFile", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/pdf" : { + "schema" : { + "format" : "binary", + "type" : "string" } }, - "application/zip": { - "schema": { - "format": "binary", - "type": "string" + "application/zip" : { + "schema" : { + "format" : "binary", + "type" : "string" } } }, - "description": "Binary export result.", - "headers": { - "Content-Disposition": { - "schema": { - "example": "attachment; filename='result.pdf'", - "pattern": "attachment; filename='[^']+'", - "type": "string" + "description" : "Binary export result.", + "headers" : { + "Content-Disposition" : { + "schema" : { + "example" : "attachment; filename='result.pdf'", + "pattern" : "attachment; filename='[^']+'", + "type" : "string" }, - "style": "simple" + "style" : "simple" } } }, - "202": { - "content": { - "application/pdf": { - "schema": { - "format": "binary", - "type": "string" + "202" : { + "content" : { + "application/pdf" : { + "schema" : { + "format" : "binary", + "type" : "string" } }, - "application/zip": { - "schema": { - "format": "binary", - "type": "string" + "application/zip" : { + "schema" : { + "format" : "binary", + "type" : "string" } } }, - "description": "Request is accepted, provided exportId exists, but export is not yet ready." + "description" : "Request is accepted, provided exportId exists, but export is not yet ready." } }, - "summary": "Retrieve exported files", - "tags": [ - "actions", - "Visual export" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "EXPORT_PDF" - ] + "summary" : "Retrieve exported files", + "tags" : [ "actions", "Visual export" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "EXPORT_PDF" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata": { - "get": { - "description": "This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified.", - "operationId": "getMetadata", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "exportId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": {} - }, - "description": "Json metadata representation" - } - }, - "summary": "Retrieve metadata context", - "tags": [ - "actions", - "Visual export" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "EXPORT_PDF" - ] + "/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata" : { + "get" : { + "description" : "This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified.", + "operationId" : "getMetadata", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "exportId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { } + }, + "description" : "Json metadata representation" + } + }, + "summary" : "Retrieve metadata context", + "tags" : [ "actions", "Visual export" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "EXPORT_PDF" ] } } } }, - "servers": [ - { - "description": "GoodData.CN endpoint", - "url": "/" - } - ], - "tags": [ - { - "description": "| execution of some form of computation (RPC over JSON)", - "name": "actions" - } - ] -} + "servers" : [ { + "description" : "GoodData.CN endpoint", + "url" : "/" + } ], + "tags" : [ { + "description" : "| execution of some form of computation (RPC over JSON)", + "name" : "actions" + } ] +} \ No newline at end of file diff --git a/schemas/gooddata-metadata-client.json b/schemas/gooddata-metadata-client.json index e000ed4a4..68da7dc29 100644 --- a/schemas/gooddata-metadata-client.json +++ b/schemas/gooddata-metadata-client.json @@ -1,51945 +1,42367 @@ { - "components": { - "parameters": { - "idPathParameter": { - "in": "path", - "name": "id", - "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "components" : { + "parameters" : { + "idPathParameter" : { + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" } }, - "page": { - "description": "Zero-based page index (0..N)", - "in": "query", - "name": "page", - "schema": { - "default": 0, - "type": "integer" + "page" : { + "description" : "Zero-based page index (0..N)", + "in" : "query", + "name" : "page", + "schema" : { + "default" : 0, + "type" : "integer" } }, - "size": { - "description": "The size of the page to be returned", - "in": "query", - "name": "size", - "schema": { - "default": 20, - "type": "integer" + "size" : { + "description" : "The size of the page to be returned", + "in" : "query", + "name" : "size", + "schema" : { + "default" : 20, + "type" : "integer" } }, - "sort": { - "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", - "in": "query", - "name": "sort", - "schema": { - "items": { - "type": "string" + "sort" : { + "description" : "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", + "in" : "query", + "name" : "sort", + "schema" : { + "items" : { + "type" : "string" }, - "type": "array" + "type" : "array" } } }, - "responses": { - "Deleted": { - "description": "Successfully deleted" + "responses" : { + "Deleted" : { + "description" : "Successfully deleted" } }, - "schemas": { - "AFM": { - "description": "Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.", - "properties": { - "attributes": { - "description": "Attributes to be used in the computation.", - "items": { - "$ref": "#/components/schemas/AttributeItem" - }, - "type": "array" - }, - "auxMeasures": { - "description": "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "type": "array" - }, - "filters": { - "description": "Various filter types to filter the execution result.", - "items": { - "$ref": "#/components/schemas/FilterDefinition" - }, - "type": "array" - }, - "measures": { - "description": "Metrics to be computed.", - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "type": "array" - } - }, - "required": [ - "attributes", - "filters", - "measures" - ], - "type": "object" - }, - "AacAnalyticsModel": { - "description": "AAC analytics model representation compatible with Analytics-as-Code YAML format.", - "properties": { - "attribute_hierarchies": { - "description": "An array of attribute hierarchies.", - "items": { - "$ref": "#/components/schemas/AacAttributeHierarchy" - }, - "type": "array" - }, - "dashboards": { - "description": "An array of dashboards.", - "items": { - "$ref": "#/components/schemas/AacDashboard" - }, - "type": "array" - }, - "metrics": { - "description": "An array of metrics.", - "items": { - "$ref": "#/components/schemas/AacMetric" - }, - "type": "array" - }, - "plugins": { - "description": "An array of dashboard plugins.", - "items": { - "$ref": "#/components/schemas/AacPlugin" - }, - "type": "array" - }, - "visualizations": { - "description": "An array of visualizations.", - "items": { - "$ref": "#/components/schemas/AacVisualization" - }, - "type": "array" - } - }, - "type": "object" - }, - "AacAttributeHierarchy": { - "description": "AAC attribute hierarchy definition.", - "properties": { - "attributes": { - "description": "Ordered list of attribute identifiers (first is top level).", - "example": [ - "attribute/country", - "attribute/state", - "attribute/city" - ], - "items": { - "description": "Ordered list of attribute identifiers (first is top level).", - "example": "[\"attribute/country\",\"attribute/state\",\"attribute/city\"]", - "type": "string" - }, - "type": "array" - }, - "description": { - "description": "Attribute hierarchy description.", - "type": "string" - }, - "id": { - "description": "Unique identifier of the attribute hierarchy.", - "example": "geo-hierarchy", - "type": "string" - }, - "tags": { - "description": "Metadata tags.", - "items": { - "description": "Metadata tags.", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Human readable title.", - "example": "Geographic Hierarchy", - "type": "string" - }, - "type": { - "description": "Attribute hierarchy type discriminator.", - "example": "attribute_hierarchy", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "AacContainerWidget": { - "allOf": [ - { - "not": { - "required": [ - "visualization" - ] - } - }, - { - "not": { - "required": [ - "content" - ] - } - }, - { - "not": { - "required": [ - "visualizations" - ] - } - } - ], - "properties": { - "additionalProperties": { - "additionalProperties": { - "$ref": "#/components/schemas/JsonNode" + "schemas" : { + "AFM" : { + "description" : "Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.", + "properties" : { + "attributes" : { + "description" : "Attributes to be used in the computation.", + "items" : { + "$ref" : "#/components/schemas/AttributeItem" }, - "type": "object", - "writeOnly": true - }, - "columns": { - "description": "Widget width in grid columns (GAAC).", - "format": "int32", - "type": "integer" - }, - "container": { - "description": "Container widget identifier.", - "type": "string" + "type" : "array" }, - "content": { - "description": "Rich text content.", - "type": "string" - }, - "date": { - "description": "Date dataset for filtering.", - "type": "string" - }, - "description": { - "oneOf": [ - { - "type": "string" - }, - { - "enum": [ - false - ], - "type": "boolean" - }, - { - "enum": [ - "inherit" - ], - "type": "string" - } - ] - }, - "drill_down": { - "$ref": "#/components/schemas/JsonNode" - }, - "enable_section_headers": { - "description": "Whether section headers are enabled for container widgets.", - "type": "boolean" + "auxMeasures" : { + "description" : "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", + "items" : { + "$ref" : "#/components/schemas/MeasureItem" + }, + "type" : "array" }, - "ignore_dashboard_filters": { - "description": "Deprecated. Use ignoredFilters instead.", - "items": { - "description": "Deprecated. Use ignoredFilters instead.", - "type": "string" + "filters" : { + "description" : "Various filter types to filter the execution result.", + "items" : { + "$ref" : "#/components/schemas/FilterDefinition" }, - "type": "array" + "type" : "array" }, - "ignored_filters": { - "description": "A list of dashboard filters to be ignored for this widget (GAAC).", - "items": { - "description": "A list of dashboard filters to be ignored for this widget (GAAC).", - "type": "string" + "measures" : { + "description" : "Metrics to be computed.", + "items" : { + "$ref" : "#/components/schemas/MeasureItem" }, - "type": "array" + "type" : "array" + } + }, + "required" : [ "attributes", "filters", "measures" ], + "type" : "object" + }, + "AacAnalyticsModel" : { + "description" : "AAC analytics model representation compatible with Analytics-as-Code YAML format.", + "properties" : { + "attribute_hierarchies" : { + "description" : "An array of attribute hierarchies.", + "items" : { + "$ref" : "#/components/schemas/AacAttributeHierarchy" + }, + "type" : "array" }, - "interactions": { - "description": "Widget interactions (GAAC).", - "items": { - "$ref": "#/components/schemas/JsonNode" + "dashboards" : { + "description" : "An array of dashboards.", + "items" : { + "$ref" : "#/components/schemas/AacDashboard" }, - "type": "array" + "type" : "array" }, - "layout_direction": { - "description": "Layout direction for container widgets.", - "type": "string" - }, - "metric": { - "description": "Inline metric reference.", - "type": "string" + "metrics" : { + "description" : "An array of metrics.", + "items" : { + "$ref" : "#/components/schemas/AacMetric" + }, + "type" : "array" }, - "rows": { - "description": "Widget height in grid rows (GAAC).", - "format": "int32", - "type": "integer" + "plugins" : { + "description" : "An array of dashboard plugins.", + "items" : { + "$ref" : "#/components/schemas/AacPlugin" + }, + "type" : "array" }, - "sections": { - "description": "Nested sections for layout widgets.", - "items": { - "$ref": "#/components/schemas/AacSection" + "visualizations" : { + "description" : "An array of visualizations.", + "items" : { + "$ref" : "#/components/schemas/AacVisualization" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "AacAttributeHierarchy" : { + "description" : "AAC attribute hierarchy definition.", + "properties" : { + "attributes" : { + "description" : "Ordered list of attribute identifiers (first is top level).", + "example" : [ "attribute/country", "attribute/state", "attribute/city" ], + "items" : { + "description" : "Ordered list of attribute identifiers (first is top level).", + "example" : "[\"attribute/country\",\"attribute/state\",\"attribute/city\"]", + "type" : "string" + }, + "type" : "array" + }, + "description" : { + "description" : "Attribute hierarchy description.", + "type" : "string" + }, + "id" : { + "description" : "Unique identifier of the attribute hierarchy.", + "example" : "geo-hierarchy", + "type" : "string" + }, + "tags" : { + "description" : "Metadata tags.", + "items" : { + "description" : "Metadata tags.", + "type" : "string" }, - "type": "array" - }, - "size": { - "$ref": "#/components/schemas/AacWidgetSize" + "type" : "array", + "uniqueItems" : true }, - "title": { - "oneOf": [ - { - "type": "string" - }, - { - "enum": [ - false - ], - "type": "boolean" - } - ] + "title" : { + "description" : "Human readable title.", + "example" : "Geographic Hierarchy", + "type" : "string" }, - "type": { - "description": "Widget type.", - "example": "visualization", - "type": "string" + "type" : { + "description" : "Attribute hierarchy type discriminator.", + "example" : "attribute_hierarchy", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "AacContainerWidget" : { + "allOf" : [ { + "not" : { + "required" : [ "visualization" ] + } + }, { + "not" : { + "required" : [ "content" ] + } + }, { + "not" : { + "required" : [ "visualizations" ] + } + } ], + "properties" : { + "additionalProperties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "object", + "writeOnly" : true + }, + "columns" : { + "description" : "Widget width in grid columns (GAAC).", + "format" : "int32", + "type" : "integer" + }, + "container" : { + "description" : "Container widget identifier.", + "type" : "string" + }, + "content" : { + "description" : "Rich text content.", + "type" : "string" }, - "visualization": { - "description": "Visualization ID reference.", - "type": "string" + "date" : { + "description" : "Date dataset for filtering.", + "type" : "string" + }, + "description" : { + "oneOf" : [ { + "type" : "string" + }, { + "enum" : [ false ], + "type" : "boolean" + }, { + "enum" : [ "inherit" ], + "type" : "string" + } ] + }, + "drill_down" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "enable_section_headers" : { + "description" : "Whether section headers are enabled for container widgets.", + "type" : "boolean" + }, + "ignore_dashboard_filters" : { + "description" : "Deprecated. Use ignoredFilters instead.", + "items" : { + "description" : "Deprecated. Use ignoredFilters instead.", + "type" : "string" + }, + "type" : "array" + }, + "ignored_filters" : { + "description" : "A list of dashboard filters to be ignored for this widget (GAAC).", + "items" : { + "description" : "A list of dashboard filters to be ignored for this widget (GAAC).", + "type" : "string" + }, + "type" : "array" + }, + "interactions" : { + "description" : "Widget interactions (GAAC).", + "items" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "array" + }, + "layout_direction" : { + "description" : "Layout direction for container widgets.", + "type" : "string" + }, + "metric" : { + "description" : "Inline metric reference.", + "type" : "string" + }, + "rows" : { + "description" : "Widget height in grid rows (GAAC).", + "format" : "int32", + "type" : "integer" + }, + "sections" : { + "description" : "Nested sections for layout widgets.", + "items" : { + "$ref" : "#/components/schemas/AacSection" + }, + "type" : "array" + }, + "size" : { + "$ref" : "#/components/schemas/AacWidgetSize" + }, + "title" : { + "oneOf" : [ { + "type" : "string" + }, { + "enum" : [ false ], + "type" : "boolean" + } ] + }, + "type" : { + "description" : "Widget type.", + "example" : "visualization", + "type" : "string" + }, + "visualization" : { + "description" : "Visualization ID reference.", + "type" : "string" + }, + "visualizations" : { + "description" : "Visualization switcher items.", + "items" : { + "$ref" : "#/components/schemas/AacWidget" + }, + "type" : "array" + }, + "zoom_data" : { + "description" : "Enable zooming to the data for certain visualization types (GAAC).", + "type" : "boolean" + } + }, + "required" : [ "sections" ], + "type" : "object" + }, + "AacDashboard" : { + "description" : "AAC dashboard definition.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AacDashboardWithTabs" + }, { + "$ref" : "#/components/schemas/AacDashboardWithoutTabs" + } ] + }, + "AacDashboardFilter" : { + "description" : "Tab-specific filters.", + "properties" : { + "date" : { + "description" : "Date dataset reference.", + "type" : "string" }, - "visualizations": { - "description": "Visualization switcher items.", - "items": { - "$ref": "#/components/schemas/AacWidget" - }, - "type": "array" + "display_as" : { + "description" : "Display as label.", + "type" : "string" + }, + "from" : { + "oneOf" : [ { + "type" : "string" + }, { + "format" : "int32", + "type" : "integer" + } ] }, - "zoom_data": { - "description": "Enable zooming to the data for certain visualization types (GAAC).", - "type": "boolean" + "granularity" : { + "description" : "Date granularity.", + "type" : "string" + }, + "metric_filters" : { + "description" : "Metric filters for validation.", + "items" : { + "description" : "Metric filters for validation.", + "type" : "string" + }, + "type" : "array" + }, + "mode" : { + "description" : "Filter mode.", + "example" : "active", + "type" : "string" + }, + "multiselect" : { + "description" : "Whether multiselect is enabled.", + "type" : "boolean" + }, + "parents" : { + "description" : "Parent filter references.", + "items" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "array" + }, + "state" : { + "$ref" : "#/components/schemas/AacFilterState" + }, + "title" : { + "description" : "Filter title.", + "type" : "string" + }, + "to" : { + "oneOf" : [ { + "type" : "string" + }, { + "format" : "int32", + "type" : "integer" + } ] + }, + "type" : { + "description" : "Filter type.", + "example" : "attribute_filter", + "type" : "string" + }, + "using" : { + "description" : "Attribute or label to filter by.", + "type" : "string" } }, - "required": [ - "sections" - ], - "type": "object" - }, - "AacDashboard": { - "description": "AAC dashboard definition.", - "oneOf": [ - { - "$ref": "#/components/schemas/AacDashboardWithTabs" + "required" : [ "type" ], + "type" : "object" + }, + "AacDashboardPermissions" : { + "description" : "Dashboard permissions.", + "properties" : { + "edit" : { + "$ref" : "#/components/schemas/AacPermission" }, - { - "$ref": "#/components/schemas/AacDashboardWithoutTabs" + "share" : { + "$ref" : "#/components/schemas/AacPermission" + }, + "view" : { + "$ref" : "#/components/schemas/AacPermission" + } + }, + "type" : "object" + }, + "AacDashboardPluginLink" : { + "description" : "Dashboard plugins.", + "properties" : { + "id" : { + "description" : "Plugin ID.", + "type" : "string" + }, + "parameters" : { + "$ref" : "#/components/schemas/JsonNode" } - ] + }, + "required" : [ "id" ], + "type" : "object" }, - "AacDashboardFilter": { - "description": "Tab-specific filters.", - "properties": { - "date": { - "description": "Date dataset reference.", - "type": "string" + "AacDashboardWithTabs" : { + "allOf" : [ { + "not" : { + "required" : [ "sections" ] + } + } ], + "properties" : { + "active_tab_id" : { + "description" : "Active tab ID for tabbed dashboards.", + "type" : "string" }, - "display_as": { - "description": "Display as label.", - "type": "string" + "cross_filtering" : { + "description" : "Whether cross filtering is enabled.", + "type" : "boolean" }, - "from": { - "oneOf": [ - { - "type": "string" - }, - { - "format": "int32", - "type": "integer" - } - ] + "description" : { + "description" : "Dashboard description.", + "type" : "string" + }, + "enable_section_headers" : { + "description" : "Whether section headers are enabled.", + "type" : "boolean" }, - "granularity": { - "description": "Date granularity.", - "type": "string" + "filter_views" : { + "description" : "Whether filter views are enabled.", + "type" : "boolean" }, - "metric_filters": { - "description": "Metric filters for validation.", - "items": { - "description": "Metric filters for validation.", - "type": "string" + "filters" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/AacDashboardFilter" }, - "type": "array" + "description" : "Dashboard filters.", + "type" : "object" }, - "mode": { - "description": "Filter mode.", - "example": "active", - "type": "string" + "id" : { + "description" : "Unique identifier of the dashboard.", + "example" : "sales-overview", + "type" : "string" }, - "multiselect": { - "description": "Whether multiselect is enabled.", - "type": "boolean" + "permissions" : { + "$ref" : "#/components/schemas/AacDashboardPermissions" }, - "parents": { - "description": "Parent filter references.", - "items": { - "$ref": "#/components/schemas/JsonNode" + "plugins" : { + "description" : "Dashboard plugins.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "$ref" : "#/components/schemas/AacDashboardPluginLink" + } ] + }, + "type" : "array" + }, + "sections" : { + "description" : "Dashboard sections (for non-tabbed dashboards).", + "items" : { + "$ref" : "#/components/schemas/AacSection" }, - "type": "array" + "type" : "array" }, - "state": { - "$ref": "#/components/schemas/AacFilterState" + "tabs" : { + "description" : "Dashboard tabs (for tabbed dashboards).", + "items" : { + "$ref" : "#/components/schemas/AacTab" + }, + "type" : "array" }, - "title": { - "description": "Filter title.", - "type": "string" + "tags" : { + "description" : "Metadata tags.", + "items" : { + "description" : "Metadata tags.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true }, - "to": { - "oneOf": [ - { - "type": "string" - }, - { - "format": "int32", - "type": "integer" - } - ] + "title" : { + "description" : "Human readable title.", + "example" : "Sales Overview", + "type" : "string" }, - "type": { - "description": "Filter type.", - "example": "attribute_filter", - "type": "string" + "type" : { + "description" : "Dashboard type discriminator.", + "example" : "dashboard", + "type" : "string" + }, + "user_filters_reset" : { + "description" : "Whether user can reset custom filters.", + "type" : "boolean" + }, + "user_filters_save" : { + "description" : "Whether user filter settings are stored.", + "type" : "boolean" + } + }, + "required" : [ "id", "tabs", "type" ], + "type" : "object" + }, + "AacDashboardWithoutTabs" : { + "allOf" : [ { + "not" : { + "required" : [ "tabs" ] + } + }, { + "not" : { + "required" : [ "active_tab_id" ] + } + } ], + "properties" : { + "active_tab_id" : { + "description" : "Active tab ID for tabbed dashboards.", + "type" : "string" + }, + "cross_filtering" : { + "description" : "Whether cross filtering is enabled.", + "type" : "boolean" + }, + "description" : { + "description" : "Dashboard description.", + "type" : "string" + }, + "enable_section_headers" : { + "description" : "Whether section headers are enabled.", + "type" : "boolean" + }, + "filter_views" : { + "description" : "Whether filter views are enabled.", + "type" : "boolean" + }, + "filters" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/AacDashboardFilter" + }, + "description" : "Dashboard filters.", + "type" : "object" + }, + "id" : { + "description" : "Unique identifier of the dashboard.", + "example" : "sales-overview", + "type" : "string" + }, + "permissions" : { + "$ref" : "#/components/schemas/AacDashboardPermissions" + }, + "plugins" : { + "description" : "Dashboard plugins.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "$ref" : "#/components/schemas/AacDashboardPluginLink" + } ] + }, + "type" : "array" + }, + "sections" : { + "description" : "Dashboard sections (for non-tabbed dashboards).", + "items" : { + "$ref" : "#/components/schemas/AacSection" + }, + "type" : "array" + }, + "tabs" : { + "description" : "Dashboard tabs (for tabbed dashboards).", + "items" : { + "$ref" : "#/components/schemas/AacTab" + }, + "type" : "array" + }, + "tags" : { + "description" : "Metadata tags.", + "items" : { + "description" : "Metadata tags.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Human readable title.", + "example" : "Sales Overview", + "type" : "string" + }, + "type" : { + "description" : "Dashboard type discriminator.", + "example" : "dashboard", + "type" : "string" + }, + "user_filters_reset" : { + "description" : "Whether user can reset custom filters.", + "type" : "boolean" + }, + "user_filters_save" : { + "description" : "Whether user filter settings are stored.", + "type" : "boolean" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "AacDataset" : { + "description" : "AAC dataset definition.", + "properties" : { + "data_source" : { + "description" : "Data source ID.", + "example" : "my-postgres", + "type" : "string" + }, + "description" : { + "description" : "Dataset description.", + "type" : "string" + }, + "fields" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/AacField" + }, + "description" : "Dataset fields (attributes, facts, aggregated facts).", + "type" : "object" + }, + "id" : { + "description" : "Unique identifier of the dataset.", + "example" : "customers", + "type" : "string" + }, + "precedence" : { + "description" : "Precedence value for aggregate awareness.", + "format" : "int32", + "type" : "integer" + }, + "primary_key" : { + "description" : "Primary key column(s). Accepts either a single string or an array of strings.", + "oneOf" : [ { + "type" : "string" + }, { + "items" : { + "type" : "string" + }, + "type" : "array" + }, { + "type" : "null" + } ] + }, + "references" : { + "description" : "References to other datasets.", + "items" : { + "$ref" : "#/components/schemas/AacReference" + }, + "type" : "array" + }, + "sql" : { + "description" : "SQL statement defining this dataset.", + "type" : "string" + }, + "table_path" : { + "description" : "Table path in the data source.", + "example" : "public/customers", + "type" : "string" + }, + "tags" : { + "description" : "Metadata tags.", + "items" : { + "description" : "Metadata tags.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Human readable title.", + "example" : "Customers", + "type" : "string" + }, + "type" : { + "description" : "Dataset type discriminator.", + "example" : "dataset", + "type" : "string" + }, + "workspace_data_filters" : { + "description" : "Workspace data filters.", + "items" : { + "$ref" : "#/components/schemas/AacWorkspaceDataFilter" + }, + "type" : "array" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "AacDateDataset" : { + "description" : "AAC date dataset definition.", + "properties" : { + "description" : { + "description" : "Date dataset description.", + "type" : "string" + }, + "granularities" : { + "description" : "List of granularities.", + "items" : { + "description" : "List of granularities.", + "type" : "string" + }, + "type" : "array" + }, + "id" : { + "description" : "Unique identifier of the date dataset.", + "example" : "date", + "type" : "string" + }, + "tags" : { + "description" : "Metadata tags.", + "items" : { + "description" : "Metadata tags.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Human readable title.", + "example" : "Date", + "type" : "string" + }, + "title_base" : { + "description" : "Title base for formatting.", + "type" : "string" + }, + "title_pattern" : { + "description" : "Title pattern for formatting.", + "type" : "string" + }, + "type" : { + "description" : "Dataset type discriminator.", + "example" : "date", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "AacField" : { + "description" : "AAC field definition (attribute, fact, or aggregated_fact).", + "properties" : { + "aggregated_as" : { + "description" : "Aggregation method.", + "example" : "SUM", + "type" : "string" + }, + "assigned_to" : { + "description" : "Source fact ID for aggregated fact.", + "type" : "string" + }, + "data_type" : { + "description" : "Data type of the column.", + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "example" : "STRING", + "type" : "string" + }, + "default_view" : { + "description" : "Default view label ID.", + "type" : "string" + }, + "description" : { + "description" : "Field description.", + "type" : "string" + }, + "is_hidden" : { + "description" : "Deprecated. Use showInAiResults instead.", + "type" : "boolean" }, - "using": { - "description": "Attribute or label to filter by.", - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "AacDashboardPermissions": { - "description": "Dashboard permissions.", - "properties": { - "edit": { - "$ref": "#/components/schemas/AacPermission" + "labels" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/AacLabel" + }, + "description" : "Attribute labels.", + "type" : "object" + }, + "locale" : { + "description" : "Locale for sorting.", + "type" : "string" + }, + "show_in_ai_results" : { + "description" : "Whether to show in AI results.", + "type" : "boolean" }, - "share": { - "$ref": "#/components/schemas/AacPermission" + "sort_column" : { + "description" : "Sort column name.", + "type" : "string" + }, + "sort_direction" : { + "description" : "Sort direction.", + "enum" : [ "ASC", "DESC" ], + "example" : "ASC", + "type" : "string" + }, + "source_column" : { + "description" : "Source column in the physical database.", + "type" : "string" + }, + "tags" : { + "description" : "Metadata tags.", + "items" : { + "description" : "Metadata tags.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Human readable title.", + "type" : "string" + }, + "type" : { + "description" : "Field type.", + "example" : "attribute", + "type" : "string" + } + }, + "required" : [ "type" ], + "type" : "object" + }, + "AacFilterState" : { + "description" : "Filter state.", + "properties" : { + "exclude" : { + "description" : "Excluded values.", + "items" : { + "description" : "Excluded values.", + "type" : "string" + }, + "type" : "array" }, - "view": { - "$ref": "#/components/schemas/AacPermission" + "include" : { + "description" : "Included values.", + "items" : { + "description" : "Included values.", + "type" : "string" + }, + "type" : "array" } }, - "type": "object" + "type" : "object" }, - "AacDashboardPluginLink": { - "description": "Dashboard plugins.", - "properties": { - "id": { - "description": "Plugin ID.", - "type": "string" - }, - "parameters": { - "$ref": "#/components/schemas/JsonNode" + "AacGeoAreaConfig" : { + "description" : "GEO area configuration.", + "properties" : { + "collection" : { + "$ref" : "#/components/schemas/AacGeoCollectionIdentifier" } }, - "required": [ - "id" - ], - "type": "object" + "required" : [ "collection" ], + "type" : "object" }, - "AacDashboardWithTabs": { - "allOf": [ - { - "not": { - "required": [ - "sections" - ] - } - } - ], - "properties": { - "active_tab_id": { - "description": "Active tab ID for tabbed dashboards.", - "type": "string" - }, - "cross_filtering": { - "description": "Whether cross filtering is enabled.", - "type": "boolean" - }, - "description": { - "description": "Dashboard description.", - "type": "string" - }, - "enable_section_headers": { - "description": "Whether section headers are enabled.", - "type": "boolean" - }, - "filter_views": { - "description": "Whether filter views are enabled.", - "type": "boolean" - }, - "filters": { - "additionalProperties": { - "$ref": "#/components/schemas/AacDashboardFilter" - }, - "description": "Dashboard filters.", - "type": "object" - }, - "id": { - "description": "Unique identifier of the dashboard.", - "example": "sales-overview", - "type": "string" - }, - "permissions": { - "$ref": "#/components/schemas/AacDashboardPermissions" - }, - "plugins": { - "description": "Dashboard plugins.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/AacDashboardPluginLink" - } - ] - }, - "type": "array" - }, - "sections": { - "description": "Dashboard sections (for non-tabbed dashboards).", - "items": { - "$ref": "#/components/schemas/AacSection" - }, - "type": "array" - }, - "tabs": { - "description": "Dashboard tabs (for tabbed dashboards).", - "items": { - "$ref": "#/components/schemas/AacTab" - }, - "type": "array" - }, - "tags": { - "description": "Metadata tags.", - "items": { - "description": "Metadata tags.", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Human readable title.", - "example": "Sales Overview", - "type": "string" - }, - "type": { - "description": "Dashboard type discriminator.", - "example": "dashboard", - "type": "string" - }, - "user_filters_reset": { - "description": "Whether user can reset custom filters.", - "type": "boolean" - }, - "user_filters_save": { - "description": "Whether user filter settings are stored.", - "type": "boolean" - } - }, - "required": [ - "id", - "tabs", - "type" - ], - "type": "object" - }, - "AacDashboardWithoutTabs": { - "allOf": [ - { - "not": { - "required": [ - "tabs" - ] - } + "AacGeoCollectionIdentifier" : { + "description" : "GEO collection configuration.", + "properties" : { + "id" : { + "description" : "Collection identifier.", + "type" : "string" }, - { - "not": { - "required": [ - "active_tab_id" - ] - } + "kind" : { + "default" : "STATIC", + "description" : "Type of geo collection.", + "enum" : [ "STATIC", "CUSTOM" ], + "type" : "string" } - ], - "properties": { - "active_tab_id": { - "description": "Active tab ID for tabbed dashboards.", - "type": "string" - }, - "cross_filtering": { - "description": "Whether cross filtering is enabled.", - "type": "boolean" + }, + "required" : [ "id" ], + "type" : "object" + }, + "AacLabel" : { + "description" : "AAC label definition.", + "properties" : { + "data_type" : { + "description" : "Data type of the column.", + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "type" : "string" }, - "description": { - "description": "Dashboard description.", - "type": "string" + "description" : { + "description" : "Label description.", + "type" : "string" }, - "enable_section_headers": { - "description": "Whether section headers are enabled.", - "type": "boolean" + "geo_area_config" : { + "$ref" : "#/components/schemas/AacGeoAreaConfig" }, - "filter_views": { - "description": "Whether filter views are enabled.", - "type": "boolean" + "is_hidden" : { + "description" : "Deprecated. Use showInAiResults instead.", + "type" : "boolean" }, - "filters": { - "additionalProperties": { - "$ref": "#/components/schemas/AacDashboardFilter" - }, - "description": "Dashboard filters.", - "type": "object" + "locale" : { + "description" : "Locale for sorting.", + "type" : "string" }, - "id": { - "description": "Unique identifier of the dashboard.", - "example": "sales-overview", - "type": "string" + "show_in_ai_results" : { + "description" : "Whether to show in AI results.", + "type" : "boolean" }, - "permissions": { - "$ref": "#/components/schemas/AacDashboardPermissions" - }, - "plugins": { - "description": "Dashboard plugins.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "$ref": "#/components/schemas/AacDashboardPluginLink" - } - ] - }, - "type": "array" + "source_column" : { + "description" : "Source column name.", + "type" : "string" }, - "sections": { - "description": "Dashboard sections (for non-tabbed dashboards).", - "items": { - "$ref": "#/components/schemas/AacSection" + "tags" : { + "description" : "Metadata tags.", + "items" : { + "description" : "Metadata tags.", + "type" : "string" }, - "type": "array" + "type" : "array", + "uniqueItems" : true }, - "tabs": { - "description": "Dashboard tabs (for tabbed dashboards).", - "items": { - "$ref": "#/components/schemas/AacTab" - }, - "type": "array" + "title" : { + "description" : "Human readable title.", + "type" : "string" }, - "tags": { - "description": "Metadata tags.", - "items": { - "description": "Metadata tags.", - "type": "string" + "translations" : { + "description" : "Localized source columns.", + "items" : { + "$ref" : "#/components/schemas/AacLabelTranslation" }, - "type": "array", - "uniqueItems": true + "type" : "array" }, - "title": { - "description": "Human readable title.", - "example": "Sales Overview", - "type": "string" - }, - "type": { - "description": "Dashboard type discriminator.", - "example": "dashboard", - "type": "string" - }, - "user_filters_reset": { - "description": "Whether user can reset custom filters.", - "type": "boolean" + "value_type" : { + "description" : "Value type.", + "example" : "TEXT", + "type" : "string" + } + }, + "type" : "object" + }, + "AacLabelTranslation" : { + "description" : "Localized source columns.", + "properties" : { + "locale" : { + "description" : "Locale identifier.", + "type" : "string" }, - "user_filters_save": { - "description": "Whether user filter settings are stored.", - "type": "boolean" + "source_column" : { + "description" : "Source column for translation.", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "AacDataset": { - "description": "AAC dataset definition.", - "properties": { - "data_source": { - "description": "Data source ID.", - "example": "my-postgres", - "type": "string" - }, - "description": { - "description": "Dataset description.", - "type": "string" - }, - "fields": { - "additionalProperties": { - "$ref": "#/components/schemas/AacField" - }, - "description": "Dataset fields (attributes, facts, aggregated facts).", - "type": "object" - }, - "id": { - "description": "Unique identifier of the dataset.", - "example": "customers", - "type": "string" - }, - "precedence": { - "description": "Precedence value for aggregate awareness.", - "format": "int32", - "type": "integer" - }, - "primary_key": { - "description": "Primary key column(s). Accepts either a single string or an array of strings.", - "oneOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ] - }, - "references": { - "description": "References to other datasets.", - "items": { - "$ref": "#/components/schemas/AacReference" - }, - "type": "array" - }, - "sql": { - "description": "SQL statement defining this dataset.", - "type": "string" - }, - "table_path": { - "description": "Table path in the data source.", - "example": "public/customers", - "type": "string" - }, - "tags": { - "description": "Metadata tags.", - "items": { - "description": "Metadata tags.", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Human readable title.", - "example": "Customers", - "type": "string" - }, - "type": { - "description": "Dataset type discriminator.", - "example": "dataset", - "type": "string" - }, - "workspace_data_filters": { - "description": "Workspace data filters.", - "items": { - "$ref": "#/components/schemas/AacWorkspaceDataFilter" - }, - "type": "array" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "AacDateDataset": { - "description": "AAC date dataset definition.", - "properties": { - "description": { - "description": "Date dataset description.", - "type": "string" - }, - "granularities": { - "description": "List of granularities.", - "items": { - "description": "List of granularities.", - "type": "string" - }, - "type": "array" - }, - "id": { - "description": "Unique identifier of the date dataset.", - "example": "date", - "type": "string" - }, - "tags": { - "description": "Metadata tags.", - "items": { - "description": "Metadata tags.", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Human readable title.", - "example": "Date", - "type": "string" - }, - "title_base": { - "description": "Title base for formatting.", - "type": "string" - }, - "title_pattern": { - "description": "Title pattern for formatting.", - "type": "string" - }, - "type": { - "description": "Dataset type discriminator.", - "example": "date", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "AacField": { - "description": "AAC field definition (attribute, fact, or aggregated_fact).", - "properties": { - "aggregated_as": { - "description": "Aggregation method.", - "example": "SUM", - "type": "string" - }, - "assigned_to": { - "description": "Source fact ID for aggregated fact.", - "type": "string" - }, - "data_type": { - "description": "Data type of the column.", - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "example": "STRING", - "type": "string" - }, - "default_view": { - "description": "Default view label ID.", - "type": "string" - }, - "description": { - "description": "Field description.", - "type": "string" - }, - "is_hidden": { - "description": "Deprecated. Use showInAiResults instead.", - "type": "boolean" - }, - "labels": { - "additionalProperties": { - "$ref": "#/components/schemas/AacLabel" - }, - "description": "Attribute labels.", - "type": "object" - }, - "locale": { - "description": "Locale for sorting.", - "type": "string" - }, - "show_in_ai_results": { - "description": "Whether to show in AI results.", - "type": "boolean" - }, - "sort_column": { - "description": "Sort column name.", - "type": "string" - }, - "sort_direction": { - "description": "Sort direction.", - "enum": [ - "ASC", - "DESC" - ], - "example": "ASC", - "type": "string" - }, - "source_column": { - "description": "Source column in the physical database.", - "type": "string" - }, - "tags": { - "description": "Metadata tags.", - "items": { - "description": "Metadata tags.", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Human readable title.", - "type": "string" - }, - "type": { - "description": "Field type.", - "example": "attribute", - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "AacFilterState": { - "description": "Filter state.", - "properties": { - "exclude": { - "description": "Excluded values.", - "items": { - "description": "Excluded values.", - "type": "string" - }, - "type": "array" - }, - "include": { - "description": "Included values.", - "items": { - "description": "Included values.", - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AacGeoAreaConfig": { - "description": "GEO area configuration.", - "properties": { - "collection": { - "$ref": "#/components/schemas/AacGeoCollectionIdentifier" - } - }, - "required": [ - "collection" - ], - "type": "object" - }, - "AacGeoCollectionIdentifier": { - "description": "GEO collection configuration.", - "properties": { - "id": { - "description": "Collection identifier.", - "type": "string" - }, - "kind": { - "default": "STATIC", - "description": "Type of geo collection.", - "enum": [ - "STATIC", - "CUSTOM" - ], - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "AacLabel": { - "description": "AAC label definition.", - "properties": { - "data_type": { - "description": "Data type of the column.", - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "type": "string" - }, - "description": { - "description": "Label description.", - "type": "string" - }, - "geo_area_config": { - "$ref": "#/components/schemas/AacGeoAreaConfig" - }, - "is_hidden": { - "description": "Deprecated. Use showInAiResults instead.", - "type": "boolean" - }, - "locale": { - "description": "Locale for sorting.", - "type": "string" - }, - "show_in_ai_results": { - "description": "Whether to show in AI results.", - "type": "boolean" - }, - "source_column": { - "description": "Source column name.", - "type": "string" - }, - "tags": { - "description": "Metadata tags.", - "items": { - "description": "Metadata tags.", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Human readable title.", - "type": "string" - }, - "translations": { - "description": "Localized source columns.", - "items": { - "$ref": "#/components/schemas/AacLabelTranslation" - }, - "type": "array" - }, - "value_type": { - "description": "Value type.", - "example": "TEXT", - "type": "string" - } - }, - "type": "object" - }, - "AacLabelTranslation": { - "description": "Localized source columns.", - "properties": { - "locale": { - "description": "Locale identifier.", - "type": "string" - }, - "source_column": { - "description": "Source column for translation.", - "type": "string" - } - }, - "required": [ - "locale", - "source_column" - ], - "type": "object" - }, - "AacLogicalModel": { - "description": "AAC logical data model representation compatible with Analytics-as-Code YAML format.", - "properties": { - "datasets": { - "description": "An array of datasets.", - "items": { - "$ref": "#/components/schemas/AacDataset" - }, - "type": "array" - }, - "date_datasets": { - "description": "An array of date datasets.", - "items": { - "$ref": "#/components/schemas/AacDateDataset" - }, - "type": "array" - } - }, - "type": "object" - }, - "AacMetric": { - "description": "AAC metric definition.", - "properties": { - "description": { - "description": "Metric description.", - "type": "string" - }, - "format": { - "description": "Default format for metric values.", - "example": "#,##0.00", - "type": "string" - }, - "id": { - "description": "Unique identifier of the metric.", - "example": "total-sales", - "type": "string" - }, - "is_hidden": { - "description": "Deprecated. Use showInAiResults instead.", - "type": "boolean" - }, - "is_hidden_from_kda": { - "description": "Whether to hide from key driver analysis.", - "type": "boolean" - }, - "maql": { - "description": "MAQL expression defining the metric.", - "example": "SELECT SUM({fact/amount})", - "type": "string" - }, - "show_in_ai_results": { - "description": "Whether to show in AI results.", - "type": "boolean" - }, - "tags": { - "description": "Metadata tags.", - "items": { - "description": "Metadata tags.", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Human readable title.", - "example": "Total Sales", - "type": "string" - }, - "type": { - "description": "Metric type discriminator.", - "example": "metric", - "type": "string" - } - }, - "required": [ - "id", - "maql", - "type" - ], - "type": "object" - }, - "AacPermission": { - "description": "SHARE permission.", - "properties": { - "all": { - "description": "Grant to all users.", - "type": "boolean" - }, - "user_groups": { - "description": "List of user group IDs.", - "items": { - "description": "List of user group IDs.", - "type": "string" - }, - "type": "array" - }, - "users": { - "description": "List of user IDs.", - "items": { - "description": "List of user IDs.", - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "AacPlugin": { - "description": "AAC dashboard plugin definition.", - "properties": { - "description": { - "description": "Plugin description.", - "type": "string" - }, - "id": { - "description": "Unique identifier of the plugin.", - "example": "my-plugin", - "type": "string" - }, - "tags": { - "description": "Metadata tags.", - "items": { - "description": "Metadata tags.", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Human readable title.", - "example": "My Plugin", - "type": "string" - }, - "type": { - "description": "Plugin type discriminator.", - "example": "plugin", - "type": "string" - }, - "url": { - "description": "URL of the plugin.", - "example": "https://example.com/plugin.js", - "type": "string" - } - }, - "required": [ - "id", - "type", - "url" - ], - "type": "object" - }, - "AacQuery": { - "description": "Query definition.", - "properties": { - "fields": { - "additionalProperties": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "description": "Query fields map: localId -> field definition (identifier string or structured object).", - "type": "object" - }, - "filter_by": { - "additionalProperties": { - "$ref": "#/components/schemas/AacQueryFilter" - }, - "description": "Query filters map: localId -> filter definition.", - "type": "object" + "required" : [ "locale", "source_column" ], + "type" : "object" + }, + "AacLogicalModel" : { + "description" : "AAC logical data model representation compatible with Analytics-as-Code YAML format.", + "properties" : { + "datasets" : { + "description" : "An array of datasets.", + "items" : { + "$ref" : "#/components/schemas/AacDataset" + }, + "type" : "array" }, - "sort_by": { - "description": "Sorting definitions.", - "items": { - "$ref": "#/components/schemas/JsonNode" + "date_datasets" : { + "description" : "An array of date datasets.", + "items" : { + "$ref" : "#/components/schemas/AacDateDataset" }, - "type": "array" + "type" : "array" } }, - "required": [ - "fields" - ], - "type": "object" + "type" : "object" }, - "AacQueryFilter": { - "description": "Layer filters.", - "properties": { - "additionalProperties": { - "additionalProperties": { - "$ref": "#/components/schemas/JsonNode" - }, - "type": "object", - "writeOnly": true - }, - "attribute": { - "description": "Attribute for ranking filter (identifier or localId).", - "type": "string" + "AacMetric" : { + "description" : "AAC metric definition.", + "properties" : { + "description" : { + "description" : "Metric description.", + "type" : "string" + }, + "format" : { + "description" : "Default format for metric values.", + "example" : "#,##0.00", + "type" : "string" }, - "bottom": { - "description": "Bottom N for ranking filter.", - "format": "int32", - "type": "integer" - }, - "condition": { - "description": "Condition for metric value filter.", - "type": "string" - }, - "dimensionality": { - "description": "Dimensionality for metric value filter.", - "items": { - "description": "Dimensionality for metric value filter.", - "type": "string" - }, - "type": "array" - }, - "display_as": { - "description": "Display as label (attribute filter).", - "type": "string" - }, - "from": { - "oneOf": [ - { - "type": "string" - }, - { - "format": "int32", - "type": "integer" - } - ] - }, - "granularity": { - "description": "Date granularity (date filter).", - "type": "string" - }, - "null_values_as_zero": { - "description": "Null values are treated as zero (metric value filter).", - "type": "boolean" - }, - "state": { - "$ref": "#/components/schemas/AacFilterState" - }, - "to": { - "oneOf": [ - { - "type": "string" - }, - { - "format": "int32", - "type": "integer" - } - ] - }, - "top": { - "description": "Top N for ranking filter.", - "format": "int32", - "type": "integer" - }, - "type": { - "description": "Filter type.", - "example": "date_filter", - "type": "string" - }, - "using": { - "description": "Reference to attribute/label/date/metric/fact (type-prefixed id).", - "type": "string" - }, - "value": { - "description": "Value for metric value filter.", - "type": "number" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "AacReference": { - "description": "AAC reference to another dataset.", - "properties": { - "dataset": { - "description": "Target dataset ID.", - "example": "orders", - "type": "string" - }, - "multi_directional": { - "description": "Whether the reference is multi-directional.", - "type": "boolean" - }, - "sources": { - "description": "Source columns for the reference.", - "items": { - "$ref": "#/components/schemas/AacReferenceSource" - }, - "type": "array" - } - }, - "required": [ - "dataset", - "sources" - ], - "type": "object" - }, - "AacReferenceSource": { - "description": "Source columns for the reference.", - "properties": { - "data_type": { - "description": "Data type of the column.", - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "type": "string" - }, - "source_column": { - "description": "Source column name.", - "type": "string" - }, - "target": { - "description": "Target in the referenced dataset.", - "type": "string" - } - }, - "required": [ - "source_column" - ], - "type": "object" - }, - "AacRichTextWidget": { - "allOf": [ - { - "not": { - "required": [ - "visualization" - ] - } + "id" : { + "description" : "Unique identifier of the metric.", + "example" : "total-sales", + "type" : "string" }, - { - "not": { - "required": [ - "sections" - ] - } + "is_hidden" : { + "description" : "Deprecated. Use showInAiResults instead.", + "type" : "boolean" }, - { - "not": { - "required": [ - "visualizations" - ] - } - } - ], - "properties": { - "additionalProperties": { - "additionalProperties": { - "$ref": "#/components/schemas/JsonNode" - }, - "type": "object", - "writeOnly": true + "is_hidden_from_kda" : { + "description" : "Whether to hide from key driver analysis.", + "type" : "boolean" }, - "columns": { - "description": "Widget width in grid columns (GAAC).", - "format": "int32", - "type": "integer" + "maql" : { + "description" : "MAQL expression defining the metric.", + "example" : "SELECT SUM({fact/amount})", + "type" : "string" + }, + "show_in_ai_results" : { + "description" : "Whether to show in AI results.", + "type" : "boolean" + }, + "tags" : { + "description" : "Metadata tags.", + "items" : { + "description" : "Metadata tags.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true }, - "container": { - "description": "Container widget identifier.", - "type": "string" + "title" : { + "description" : "Human readable title.", + "example" : "Total Sales", + "type" : "string" + }, + "type" : { + "description" : "Metric type discriminator.", + "example" : "metric", + "type" : "string" + } + }, + "required" : [ "id", "maql", "type" ], + "type" : "object" + }, + "AacPermission" : { + "description" : "SHARE permission.", + "properties" : { + "all" : { + "description" : "Grant to all users.", + "type" : "boolean" + }, + "user_groups" : { + "description" : "List of user group IDs.", + "items" : { + "description" : "List of user group IDs.", + "type" : "string" + }, + "type" : "array" }, - "content": { - "description": "Rich text content.", - "type": "string" + "users" : { + "description" : "List of user IDs.", + "items" : { + "description" : "List of user IDs.", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "AacPlugin" : { + "description" : "AAC dashboard plugin definition.", + "properties" : { + "description" : { + "description" : "Plugin description.", + "type" : "string" + }, + "id" : { + "description" : "Unique identifier of the plugin.", + "example" : "my-plugin", + "type" : "string" + }, + "tags" : { + "description" : "Metadata tags.", + "items" : { + "description" : "Metadata tags.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Human readable title.", + "example" : "My Plugin", + "type" : "string" + }, + "type" : { + "description" : "Plugin type discriminator.", + "example" : "plugin", + "type" : "string" + }, + "url" : { + "description" : "URL of the plugin.", + "example" : "https://example.com/plugin.js", + "type" : "string" + } + }, + "required" : [ "id", "type", "url" ], + "type" : "object" + }, + "AacQuery" : { + "description" : "Query definition.", + "properties" : { + "fields" : { + "additionalProperties" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "description" : "Query fields map: localId -> field definition (identifier string or structured object).", + "type" : "object" + }, + "filter_by" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/AacQueryFilter" + }, + "description" : "Query filters map: localId -> filter definition.", + "type" : "object" + }, + "sort_by" : { + "description" : "Sorting definitions.", + "items" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "array" + } + }, + "required" : [ "fields" ], + "type" : "object" + }, + "AacQueryFilter" : { + "description" : "Layer filters.", + "properties" : { + "additionalProperties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "object", + "writeOnly" : true + }, + "attribute" : { + "description" : "Attribute for ranking filter (identifier or localId).", + "type" : "string" + }, + "bottom" : { + "description" : "Bottom N for ranking filter.", + "format" : "int32", + "type" : "integer" + }, + "condition" : { + "description" : "Condition for metric value filter.", + "type" : "string" + }, + "dimensionality" : { + "description" : "Dimensionality for metric value filter.", + "items" : { + "description" : "Dimensionality for metric value filter.", + "type" : "string" + }, + "type" : "array" + }, + "display_as" : { + "description" : "Display as label (attribute filter).", + "type" : "string" + }, + "from" : { + "oneOf" : [ { + "type" : "string" + }, { + "format" : "int32", + "type" : "integer" + } ] + }, + "granularity" : { + "description" : "Date granularity (date filter).", + "type" : "string" + }, + "null_values_as_zero" : { + "description" : "Null values are treated as zero (metric value filter).", + "type" : "boolean" + }, + "state" : { + "$ref" : "#/components/schemas/AacFilterState" + }, + "to" : { + "oneOf" : [ { + "type" : "string" + }, { + "format" : "int32", + "type" : "integer" + } ] + }, + "top" : { + "description" : "Top N for ranking filter.", + "format" : "int32", + "type" : "integer" + }, + "type" : { + "description" : "Filter type.", + "example" : "date_filter", + "type" : "string" + }, + "using" : { + "description" : "Reference to attribute/label/date/metric/fact (type-prefixed id).", + "type" : "string" + }, + "value" : { + "description" : "Value for metric value filter.", + "type" : "number" + } + }, + "required" : [ "type" ], + "type" : "object" + }, + "AacReference" : { + "description" : "AAC reference to another dataset.", + "properties" : { + "dataset" : { + "description" : "Target dataset ID.", + "example" : "orders", + "type" : "string" + }, + "multi_directional" : { + "description" : "Whether the reference is multi-directional.", + "type" : "boolean" + }, + "sources" : { + "description" : "Source columns for the reference.", + "items" : { + "$ref" : "#/components/schemas/AacReferenceSource" + }, + "type" : "array" + } + }, + "required" : [ "dataset", "sources" ], + "type" : "object" + }, + "AacReferenceSource" : { + "description" : "Source columns for the reference.", + "properties" : { + "data_type" : { + "description" : "Data type of the column.", + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "type" : "string" + }, + "source_column" : { + "description" : "Source column name.", + "type" : "string" + }, + "target" : { + "description" : "Target in the referenced dataset.", + "type" : "string" + } + }, + "required" : [ "source_column" ], + "type" : "object" + }, + "AacRichTextWidget" : { + "allOf" : [ { + "not" : { + "required" : [ "visualization" ] + } + }, { + "not" : { + "required" : [ "sections" ] + } + }, { + "not" : { + "required" : [ "visualizations" ] + } + } ], + "properties" : { + "additionalProperties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "object", + "writeOnly" : true + }, + "columns" : { + "description" : "Widget width in grid columns (GAAC).", + "format" : "int32", + "type" : "integer" + }, + "container" : { + "description" : "Container widget identifier.", + "type" : "string" + }, + "content" : { + "description" : "Rich text content.", + "type" : "string" }, - "date": { - "description": "Date dataset for filtering.", - "type": "string" + "date" : { + "description" : "Date dataset for filtering.", + "type" : "string" + }, + "description" : { + "oneOf" : [ { + "type" : "string" + }, { + "enum" : [ false ], + "type" : "boolean" + }, { + "enum" : [ "inherit" ], + "type" : "string" + } ] + }, + "drill_down" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "enable_section_headers" : { + "description" : "Whether section headers are enabled for container widgets.", + "type" : "boolean" + }, + "ignore_dashboard_filters" : { + "description" : "Deprecated. Use ignoredFilters instead.", + "items" : { + "description" : "Deprecated. Use ignoredFilters instead.", + "type" : "string" + }, + "type" : "array" }, - "description": { - "oneOf": [ - { - "type": "string" - }, - { - "enum": [ - false - ], - "type": "boolean" - }, - { - "enum": [ - "inherit" - ], - "type": "string" - } - ] + "ignored_filters" : { + "description" : "A list of dashboard filters to be ignored for this widget (GAAC).", + "items" : { + "description" : "A list of dashboard filters to be ignored for this widget (GAAC).", + "type" : "string" + }, + "type" : "array" }, - "drill_down": { - "$ref": "#/components/schemas/JsonNode" + "interactions" : { + "description" : "Widget interactions (GAAC).", + "items" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "array" + }, + "layout_direction" : { + "description" : "Layout direction for container widgets.", + "type" : "string" + }, + "metric" : { + "description" : "Inline metric reference.", + "type" : "string" }, - "enable_section_headers": { - "description": "Whether section headers are enabled for container widgets.", - "type": "boolean" + "rows" : { + "description" : "Widget height in grid rows (GAAC).", + "format" : "int32", + "type" : "integer" }, - "ignore_dashboard_filters": { - "description": "Deprecated. Use ignoredFilters instead.", - "items": { - "description": "Deprecated. Use ignoredFilters instead.", - "type": "string" + "sections" : { + "description" : "Nested sections for layout widgets.", + "items" : { + "$ref" : "#/components/schemas/AacSection" + }, + "type" : "array" + }, + "size" : { + "$ref" : "#/components/schemas/AacWidgetSize" + }, + "title" : { + "oneOf" : [ { + "type" : "string" + }, { + "enum" : [ false ], + "type" : "boolean" + } ] + }, + "type" : { + "description" : "Widget type.", + "example" : "visualization", + "type" : "string" + }, + "visualization" : { + "description" : "Visualization ID reference.", + "type" : "string" + }, + "visualizations" : { + "description" : "Visualization switcher items.", + "items" : { + "$ref" : "#/components/schemas/AacWidget" + }, + "type" : "array" + }, + "zoom_data" : { + "description" : "Enable zooming to the data for certain visualization types (GAAC).", + "type" : "boolean" + } + }, + "required" : [ "content" ], + "type" : "object" + }, + "AacSection" : { + "description" : "Sections within the tab.", + "properties" : { + "description" : { + "description" : "Section description.", + "type" : "string" + }, + "header" : { + "description" : "Whether section header is visible.", + "type" : "boolean" + }, + "title" : { + "description" : "Section title.", + "type" : "string" + }, + "widgets" : { + "description" : "Widgets in the section.", + "items" : { + "$ref" : "#/components/schemas/AacWidget" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "AacTab" : { + "description" : "Dashboard tabs (for tabbed dashboards).", + "properties" : { + "filters" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/AacDashboardFilter" + }, + "description" : "Tab-specific filters.", + "type" : "object" + }, + "id" : { + "description" : "Unique identifier of the tab.", + "type" : "string" + }, + "sections" : { + "description" : "Sections within the tab.", + "items" : { + "$ref" : "#/components/schemas/AacSection" + }, + "type" : "array" + }, + "title" : { + "description" : "Display title for the tab.", + "type" : "string" + } + }, + "required" : [ "id", "title" ], + "type" : "object" + }, + "AacVisualization" : { + "description" : "AAC visualization definition.", + "discriminator" : { + "mapping" : { + "area_chart" : "#/components/schemas/AacVisualizationStackedBuckets", + "bar_chart" : "#/components/schemas/AacVisualizationStackedBuckets", + "bubble_chart" : "#/components/schemas/AacVisualizationBubbleBuckets", + "bullet_chart" : "#/components/schemas/AacVisualizationBasicBuckets", + "column_chart" : "#/components/schemas/AacVisualizationStackedBuckets", + "combo_chart" : "#/components/schemas/AacVisualizationBasicBuckets", + "dependency_wheel_chart" : "#/components/schemas/AacVisualizationDependencyBuckets", + "donut_chart" : "#/components/schemas/AacVisualizationBasicBuckets", + "funnel_chart" : "#/components/schemas/AacVisualizationBasicBuckets", + "geo_area_chart" : "#/components/schemas/AacVisualizationGeoBuckets", + "geo_chart" : "#/components/schemas/AacVisualizationGeoBuckets", + "headline_chart" : "#/components/schemas/AacVisualizationBasicBuckets", + "heatmap_chart" : "#/components/schemas/AacVisualizationTableBuckets", + "line_chart" : "#/components/schemas/AacVisualizationTrendBuckets", + "pie_chart" : "#/components/schemas/AacVisualizationBasicBuckets", + "pyramid_chart" : "#/components/schemas/AacVisualizationBasicBuckets", + "repeater_chart" : "#/components/schemas/AacVisualizationTableBuckets", + "sankey_chart" : "#/components/schemas/AacVisualizationDependencyBuckets", + "scatter_chart" : "#/components/schemas/AacVisualizationScatterBuckets", + "table" : "#/components/schemas/AacVisualizationTableBuckets", + "treemap_chart" : "#/components/schemas/AacVisualizationBasicBuckets", + "waterfall_chart" : "#/components/schemas/AacVisualizationBasicBuckets" + }, + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AacVisualizationTableBuckets" + }, { + "$ref" : "#/components/schemas/AacVisualizationStackedBuckets" + }, { + "$ref" : "#/components/schemas/AacVisualizationScatterBuckets" + }, { + "$ref" : "#/components/schemas/AacVisualizationBubbleBuckets" + }, { + "$ref" : "#/components/schemas/AacVisualizationTrendBuckets" + }, { + "$ref" : "#/components/schemas/AacVisualizationGeoBuckets" + }, { + "$ref" : "#/components/schemas/AacVisualizationBasicBuckets" + }, { + "$ref" : "#/components/schemas/AacVisualizationDependencyBuckets" + } ] + }, + "AacVisualizationBasicBuckets" : { + "allOf" : [ { + "not" : { + "required" : [ "rows" ] + } + }, { + "not" : { + "required" : [ "columns" ] + } + }, { + "not" : { + "required" : [ "from" ] + } + }, { + "not" : { + "required" : [ "to" ] + } + }, { + "not" : { + "required" : [ "stack_by" ] + } + }, { + "not" : { + "required" : [ "trend_by" ] + } + }, { + "not" : { + "required" : [ "size_by" ] + } + }, { + "not" : { + "required" : [ "attributes" ] + } + }, { + "not" : { + "required" : [ "layers" ] + } + } ], + "properties" : { + "additionalProperties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "object", + "writeOnly" : true + }, + "attributes" : { + "description" : "Attributes bucket (for scatter).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "columns" : { + "description" : "Columns bucket (for tables).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "config" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "description" : { + "description" : "Visualization description.", + "type" : "string" + }, + "from" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "id" : { + "description" : "Unique identifier of the visualization.", + "example" : "sales-by-region", + "type" : "string" + }, + "is_hidden" : { + "description" : "Deprecated. Use showInAiResults instead.", + "type" : "boolean" + }, + "layers" : { + "description" : "Visualization data layers (for geo charts).", + "items" : { + "$ref" : "#/components/schemas/AacVisualizationLayer" + }, + "type" : "array" + }, + "metrics" : { + "description" : "Metrics bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "query" : { + "$ref" : "#/components/schemas/AacQuery" + }, + "rows" : { + "description" : "Rows bucket (for tables).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "segment_by" : { + "description" : "Segment by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "show_in_ai_results" : { + "description" : "Whether to show in AI results.", + "type" : "boolean" + }, + "size_by" : { + "description" : "Size by metrics bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "stack_by" : { + "description" : "Stack by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "tags" : { + "description" : "Metadata tags.", + "items" : { + "description" : "Metadata tags.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Human readable title.", + "example" : "Sales by Region", + "type" : "string" + }, + "to" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "trend_by" : { + "description" : "Trend by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "type" : { + "enum" : [ "bullet_chart", "combo_chart", "donut_chart", "funnel_chart", "headline_chart", "pie_chart", "pyramid_chart", "treemap_chart", "waterfall_chart" ], + "type" : "string" + }, + "view_by" : { + "description" : "View by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + } + }, + "required" : [ "id", "query", "type" ], + "type" : "object" + }, + "AacVisualizationBubbleBuckets" : { + "allOf" : [ { + "not" : { + "required" : [ "rows" ] + } + }, { + "not" : { + "required" : [ "columns" ] + } + }, { + "not" : { + "required" : [ "from" ] + } + }, { + "not" : { + "required" : [ "to" ] + } + }, { + "not" : { + "required" : [ "stack_by" ] + } + }, { + "not" : { + "required" : [ "trend_by" ] + } + }, { + "not" : { + "required" : [ "attributes" ] + } + }, { + "not" : { + "required" : [ "layers" ] + } + } ], + "properties" : { + "additionalProperties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "object", + "writeOnly" : true + }, + "attributes" : { + "description" : "Attributes bucket (for scatter).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "columns" : { + "description" : "Columns bucket (for tables).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "config" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "description" : { + "description" : "Visualization description.", + "type" : "string" + }, + "from" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "id" : { + "description" : "Unique identifier of the visualization.", + "example" : "sales-by-region", + "type" : "string" + }, + "is_hidden" : { + "description" : "Deprecated. Use showInAiResults instead.", + "type" : "boolean" + }, + "layers" : { + "description" : "Visualization data layers (for geo charts).", + "items" : { + "$ref" : "#/components/schemas/AacVisualizationLayer" + }, + "type" : "array" + }, + "metrics" : { + "description" : "Metrics bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "query" : { + "$ref" : "#/components/schemas/AacQuery" + }, + "rows" : { + "description" : "Rows bucket (for tables).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "segment_by" : { + "description" : "Segment by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "show_in_ai_results" : { + "description" : "Whether to show in AI results.", + "type" : "boolean" + }, + "size_by" : { + "description" : "Size by metrics bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "stack_by" : { + "description" : "Stack by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "tags" : { + "description" : "Metadata tags.", + "items" : { + "description" : "Metadata tags.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Human readable title.", + "example" : "Sales by Region", + "type" : "string" + }, + "to" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "trend_by" : { + "description" : "Trend by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "type" : { + "enum" : [ "bubble_chart" ], + "type" : "string" + }, + "view_by" : { + "description" : "View by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + } + }, + "required" : [ "id", "query", "type" ], + "type" : "object" + }, + "AacVisualizationDependencyBuckets" : { + "allOf" : [ { + "not" : { + "required" : [ "rows" ] + } + }, { + "not" : { + "required" : [ "columns" ] + } + }, { + "not" : { + "required" : [ "stack_by" ] + } + }, { + "not" : { + "required" : [ "trend_by" ] + } + }, { + "not" : { + "required" : [ "size_by" ] + } + }, { + "not" : { + "required" : [ "attributes" ] + } + }, { + "not" : { + "required" : [ "layers" ] + } + } ], + "properties" : { + "additionalProperties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "object", + "writeOnly" : true + }, + "attributes" : { + "description" : "Attributes bucket (for scatter).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "columns" : { + "description" : "Columns bucket (for tables).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "config" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "description" : { + "description" : "Visualization description.", + "type" : "string" + }, + "from" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "id" : { + "description" : "Unique identifier of the visualization.", + "example" : "sales-by-region", + "type" : "string" + }, + "is_hidden" : { + "description" : "Deprecated. Use showInAiResults instead.", + "type" : "boolean" + }, + "layers" : { + "description" : "Visualization data layers (for geo charts).", + "items" : { + "$ref" : "#/components/schemas/AacVisualizationLayer" + }, + "type" : "array" + }, + "metrics" : { + "description" : "Metrics bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "query" : { + "$ref" : "#/components/schemas/AacQuery" + }, + "rows" : { + "description" : "Rows bucket (for tables).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "segment_by" : { + "description" : "Segment by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "show_in_ai_results" : { + "description" : "Whether to show in AI results.", + "type" : "boolean" + }, + "size_by" : { + "description" : "Size by metrics bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "stack_by" : { + "description" : "Stack by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "tags" : { + "description" : "Metadata tags.", + "items" : { + "description" : "Metadata tags.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Human readable title.", + "example" : "Sales by Region", + "type" : "string" + }, + "to" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "trend_by" : { + "description" : "Trend by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "type" : { + "enum" : [ "dependency_wheel_chart", "sankey_chart" ], + "type" : "string" + }, + "view_by" : { + "description" : "View by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + } + }, + "required" : [ "id", "query", "type" ], + "type" : "object" + }, + "AacVisualizationGeoBuckets" : { + "allOf" : [ { + "not" : { + "required" : [ "rows" ] + } + }, { + "not" : { + "required" : [ "columns" ] + } + }, { + "not" : { + "required" : [ "from" ] + } + }, { + "not" : { + "required" : [ "to" ] + } + }, { + "not" : { + "required" : [ "stack_by" ] + } + }, { + "not" : { + "required" : [ "trend_by" ] + } + }, { + "not" : { + "required" : [ "size_by" ] + } + }, { + "not" : { + "required" : [ "attributes" ] + } + } ], + "properties" : { + "additionalProperties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "object", + "writeOnly" : true + }, + "attributes" : { + "description" : "Attributes bucket (for scatter).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "columns" : { + "description" : "Columns bucket (for tables).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "config" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "description" : { + "description" : "Visualization description.", + "type" : "string" + }, + "from" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "id" : { + "description" : "Unique identifier of the visualization.", + "example" : "sales-by-region", + "type" : "string" + }, + "is_hidden" : { + "description" : "Deprecated. Use showInAiResults instead.", + "type" : "boolean" + }, + "layers" : { + "description" : "Visualization data layers (for geo charts).", + "items" : { + "$ref" : "#/components/schemas/AacVisualizationLayer" + }, + "type" : "array" + }, + "metrics" : { + "description" : "Metrics bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "query" : { + "$ref" : "#/components/schemas/AacQuery" + }, + "rows" : { + "description" : "Rows bucket (for tables).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "segment_by" : { + "description" : "Segment by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "show_in_ai_results" : { + "description" : "Whether to show in AI results.", + "type" : "boolean" + }, + "size_by" : { + "description" : "Size by metrics bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "stack_by" : { + "description" : "Stack by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "tags" : { + "description" : "Metadata tags.", + "items" : { + "description" : "Metadata tags.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Human readable title.", + "example" : "Sales by Region", + "type" : "string" + }, + "to" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "trend_by" : { + "description" : "Trend by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "type" : { + "enum" : [ "geo_chart", "geo_area_chart" ], + "type" : "string" + }, + "view_by" : { + "description" : "View by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + } + }, + "required" : [ "id", "query", "type" ], + "type" : "object" + }, + "AacVisualizationLayer" : { + "description" : "Visualization data layers (for geo charts).", + "properties" : { + "additionalProperties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "object", + "writeOnly" : true + }, + "config" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "filters" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/AacQueryFilter" + }, + "description" : "Layer filters.", + "type" : "object" + }, + "id" : { + "description" : "Unique identifier of the layer.", + "type" : "string" + }, + "metrics" : { + "description" : "Layer metrics.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "segment_by" : { + "description" : "Layer segment by.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "sorts" : { + "description" : "Layer sorting definitions.", + "items" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "array" + }, + "title" : { + "description" : "Layer title.", + "type" : "string" + }, + "type" : { + "description" : "Layer type.", + "example" : "pushpin", + "type" : "string" + }, + "view_by" : { + "description" : "Layer view by.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "AacVisualizationScatterBuckets" : { + "allOf" : [ { + "not" : { + "required" : [ "rows" ] + } + }, { + "not" : { + "required" : [ "columns" ] + } + }, { + "not" : { + "required" : [ "from" ] + } + }, { + "not" : { + "required" : [ "to" ] + } + }, { + "not" : { + "required" : [ "stack_by" ] + } + }, { + "not" : { + "required" : [ "trend_by" ] + } + }, { + "not" : { + "required" : [ "size_by" ] + } + }, { + "not" : { + "required" : [ "layers" ] + } + } ], + "properties" : { + "additionalProperties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "object", + "writeOnly" : true + }, + "attributes" : { + "description" : "Attributes bucket (for scatter).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "columns" : { + "description" : "Columns bucket (for tables).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "config" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "description" : { + "description" : "Visualization description.", + "type" : "string" + }, + "from" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "id" : { + "description" : "Unique identifier of the visualization.", + "example" : "sales-by-region", + "type" : "string" + }, + "is_hidden" : { + "description" : "Deprecated. Use showInAiResults instead.", + "type" : "boolean" + }, + "layers" : { + "description" : "Visualization data layers (for geo charts).", + "items" : { + "$ref" : "#/components/schemas/AacVisualizationLayer" + }, + "type" : "array" + }, + "metrics" : { + "description" : "Metrics bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "query" : { + "$ref" : "#/components/schemas/AacQuery" + }, + "rows" : { + "description" : "Rows bucket (for tables).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "segment_by" : { + "description" : "Segment by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "show_in_ai_results" : { + "description" : "Whether to show in AI results.", + "type" : "boolean" + }, + "size_by" : { + "description" : "Size by metrics bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "stack_by" : { + "description" : "Stack by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "tags" : { + "description" : "Metadata tags.", + "items" : { + "description" : "Metadata tags.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Human readable title.", + "example" : "Sales by Region", + "type" : "string" + }, + "to" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "trend_by" : { + "description" : "Trend by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "type" : { + "enum" : [ "scatter_chart" ], + "type" : "string" + }, + "view_by" : { + "description" : "View by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + } + }, + "required" : [ "id", "query", "type" ], + "type" : "object" + }, + "AacVisualizationStackedBuckets" : { + "allOf" : [ { + "not" : { + "required" : [ "rows" ] + } + }, { + "not" : { + "required" : [ "columns" ] + } + }, { + "not" : { + "required" : [ "from" ] + } + }, { + "not" : { + "required" : [ "to" ] + } + }, { + "not" : { + "required" : [ "trend_by" ] + } + }, { + "not" : { + "required" : [ "size_by" ] + } + }, { + "not" : { + "required" : [ "attributes" ] + } + }, { + "not" : { + "required" : [ "layers" ] + } + } ], + "properties" : { + "additionalProperties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "object", + "writeOnly" : true + }, + "attributes" : { + "description" : "Attributes bucket (for scatter).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "columns" : { + "description" : "Columns bucket (for tables).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "config" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "description" : { + "description" : "Visualization description.", + "type" : "string" + }, + "from" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "id" : { + "description" : "Unique identifier of the visualization.", + "example" : "sales-by-region", + "type" : "string" + }, + "is_hidden" : { + "description" : "Deprecated. Use showInAiResults instead.", + "type" : "boolean" + }, + "layers" : { + "description" : "Visualization data layers (for geo charts).", + "items" : { + "$ref" : "#/components/schemas/AacVisualizationLayer" + }, + "type" : "array" + }, + "metrics" : { + "description" : "Metrics bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "query" : { + "$ref" : "#/components/schemas/AacQuery" + }, + "rows" : { + "description" : "Rows bucket (for tables).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "segment_by" : { + "description" : "Segment by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "show_in_ai_results" : { + "description" : "Whether to show in AI results.", + "type" : "boolean" + }, + "size_by" : { + "description" : "Size by metrics bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "stack_by" : { + "description" : "Stack by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "tags" : { + "description" : "Metadata tags.", + "items" : { + "description" : "Metadata tags.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Human readable title.", + "example" : "Sales by Region", + "type" : "string" + }, + "to" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "trend_by" : { + "description" : "Trend by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "type" : { + "enum" : [ "bar_chart", "column_chart", "area_chart" ], + "type" : "string" + }, + "view_by" : { + "description" : "View by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + } + }, + "required" : [ "id", "query", "type" ], + "type" : "object" + }, + "AacVisualizationSwitcherWidget" : { + "allOf" : [ { + "not" : { + "required" : [ "visualization" ] + } + }, { + "not" : { + "required" : [ "content" ] + } + }, { + "not" : { + "required" : [ "sections" ] + } + } ], + "properties" : { + "additionalProperties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "object", + "writeOnly" : true + }, + "columns" : { + "description" : "Widget width in grid columns (GAAC).", + "format" : "int32", + "type" : "integer" + }, + "container" : { + "description" : "Container widget identifier.", + "type" : "string" + }, + "content" : { + "description" : "Rich text content.", + "type" : "string" + }, + "date" : { + "description" : "Date dataset for filtering.", + "type" : "string" + }, + "description" : { + "oneOf" : [ { + "type" : "string" + }, { + "enum" : [ false ], + "type" : "boolean" + }, { + "enum" : [ "inherit" ], + "type" : "string" + } ] + }, + "drill_down" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "enable_section_headers" : { + "description" : "Whether section headers are enabled for container widgets.", + "type" : "boolean" + }, + "ignore_dashboard_filters" : { + "description" : "Deprecated. Use ignoredFilters instead.", + "items" : { + "description" : "Deprecated. Use ignoredFilters instead.", + "type" : "string" + }, + "type" : "array" + }, + "ignored_filters" : { + "description" : "A list of dashboard filters to be ignored for this widget (GAAC).", + "items" : { + "description" : "A list of dashboard filters to be ignored for this widget (GAAC).", + "type" : "string" + }, + "type" : "array" + }, + "interactions" : { + "description" : "Widget interactions (GAAC).", + "items" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "array" + }, + "layout_direction" : { + "description" : "Layout direction for container widgets.", + "type" : "string" + }, + "metric" : { + "description" : "Inline metric reference.", + "type" : "string" + }, + "rows" : { + "description" : "Widget height in grid rows (GAAC).", + "format" : "int32", + "type" : "integer" + }, + "sections" : { + "description" : "Nested sections for layout widgets.", + "items" : { + "$ref" : "#/components/schemas/AacSection" + }, + "type" : "array" + }, + "size" : { + "$ref" : "#/components/schemas/AacWidgetSize" + }, + "title" : { + "oneOf" : [ { + "type" : "string" + }, { + "enum" : [ false ], + "type" : "boolean" + } ] + }, + "type" : { + "description" : "Widget type.", + "example" : "visualization", + "type" : "string" + }, + "visualization" : { + "description" : "Visualization ID reference.", + "type" : "string" + }, + "visualizations" : { + "items" : { + "$ref" : "#/components/schemas/AacVisualizationWidget" + }, + "type" : "array" + }, + "zoom_data" : { + "description" : "Enable zooming to the data for certain visualization types (GAAC).", + "type" : "boolean" + } + }, + "required" : [ "visualizations" ], + "type" : "object" + }, + "AacVisualizationTableBuckets" : { + "allOf" : [ { + "not" : { + "required" : [ "from" ] + } + }, { + "not" : { + "required" : [ "to" ] + } + }, { + "not" : { + "required" : [ "stack_by" ] + } + }, { + "not" : { + "required" : [ "trend_by" ] + } + }, { + "not" : { + "required" : [ "size_by" ] + } + }, { + "not" : { + "required" : [ "attributes" ] + } + }, { + "not" : { + "required" : [ "layers" ] + } + } ], + "properties" : { + "additionalProperties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "object", + "writeOnly" : true + }, + "attributes" : { + "description" : "Attributes bucket (for scatter).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "columns" : { + "description" : "Columns bucket (for tables).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "config" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "description" : { + "description" : "Visualization description.", + "type" : "string" + }, + "from" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "id" : { + "description" : "Unique identifier of the visualization.", + "example" : "sales-by-region", + "type" : "string" + }, + "is_hidden" : { + "description" : "Deprecated. Use showInAiResults instead.", + "type" : "boolean" + }, + "layers" : { + "description" : "Visualization data layers (for geo charts).", + "items" : { + "$ref" : "#/components/schemas/AacVisualizationLayer" + }, + "type" : "array" + }, + "metrics" : { + "description" : "Metrics bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "query" : { + "$ref" : "#/components/schemas/AacQuery" + }, + "rows" : { + "description" : "Rows bucket (for tables).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "segment_by" : { + "description" : "Segment by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "show_in_ai_results" : { + "description" : "Whether to show in AI results.", + "type" : "boolean" + }, + "size_by" : { + "description" : "Size by metrics bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "stack_by" : { + "description" : "Stack by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "tags" : { + "description" : "Metadata tags.", + "items" : { + "description" : "Metadata tags.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Human readable title.", + "example" : "Sales by Region", + "type" : "string" + }, + "to" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "trend_by" : { + "description" : "Trend by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "type" : { + "enum" : [ "table", "heatmap_chart", "repeater_chart" ], + "type" : "string" + }, + "view_by" : { + "description" : "View by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + } + }, + "required" : [ "id", "query", "type" ], + "type" : "object" + }, + "AacVisualizationTrendBuckets" : { + "allOf" : [ { + "not" : { + "required" : [ "rows" ] + } + }, { + "not" : { + "required" : [ "columns" ] + } + }, { + "not" : { + "required" : [ "from" ] + } + }, { + "not" : { + "required" : [ "to" ] + } + }, { + "not" : { + "required" : [ "stack_by" ] + } + }, { + "not" : { + "required" : [ "size_by" ] + } + }, { + "not" : { + "required" : [ "attributes" ] + } + }, { + "not" : { + "required" : [ "layers" ] + } + } ], + "properties" : { + "additionalProperties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "object", + "writeOnly" : true + }, + "attributes" : { + "description" : "Attributes bucket (for scatter).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "columns" : { + "description" : "Columns bucket (for tables).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "config" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "description" : { + "description" : "Visualization description.", + "type" : "string" + }, + "from" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "id" : { + "description" : "Unique identifier of the visualization.", + "example" : "sales-by-region", + "type" : "string" + }, + "is_hidden" : { + "description" : "Deprecated. Use showInAiResults instead.", + "type" : "boolean" + }, + "layers" : { + "description" : "Visualization data layers (for geo charts).", + "items" : { + "$ref" : "#/components/schemas/AacVisualizationLayer" + }, + "type" : "array" + }, + "metrics" : { + "description" : "Metrics bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "query" : { + "$ref" : "#/components/schemas/AacQuery" + }, + "rows" : { + "description" : "Rows bucket (for tables).", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "segment_by" : { + "description" : "Segment by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "show_in_ai_results" : { + "description" : "Whether to show in AI results.", + "type" : "boolean" + }, + "size_by" : { + "description" : "Size by metrics bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "stack_by" : { + "description" : "Stack by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "tags" : { + "description" : "Metadata tags.", + "items" : { + "description" : "Metadata tags.", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Human readable title.", + "example" : "Sales by Region", + "type" : "string" + }, + "to" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "trend_by" : { + "description" : "Trend by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + }, + "type" : { + "enum" : [ "line_chart" ], + "type" : "string" + }, + "view_by" : { + "description" : "View by attributes bucket.", + "items" : { + "oneOf" : [ { + "type" : "string" + }, { + "type" : "object" + }, { + "type" : "null" + } ] + }, + "type" : "array" + } + }, + "required" : [ "id", "query", "type" ], + "type" : "object" + }, + "AacVisualizationWidget" : { + "allOf" : [ { + "not" : { + "required" : [ "content" ] + } + }, { + "not" : { + "required" : [ "sections" ] + } + }, { + "not" : { + "required" : [ "visualizations" ] + } + } ], + "properties" : { + "additionalProperties" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "object", + "writeOnly" : true + }, + "columns" : { + "description" : "Widget width in grid columns (GAAC).", + "format" : "int32", + "type" : "integer" + }, + "container" : { + "description" : "Container widget identifier.", + "type" : "string" + }, + "content" : { + "description" : "Rich text content.", + "type" : "string" + }, + "date" : { + "description" : "Date dataset for filtering.", + "type" : "string" + }, + "description" : { + "oneOf" : [ { + "type" : "string" + }, { + "enum" : [ false ], + "type" : "boolean" + }, { + "enum" : [ "inherit" ], + "type" : "string" + } ] + }, + "drill_down" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "enable_section_headers" : { + "description" : "Whether section headers are enabled for container widgets.", + "type" : "boolean" + }, + "ignore_dashboard_filters" : { + "description" : "Deprecated. Use ignoredFilters instead.", + "items" : { + "description" : "Deprecated. Use ignoredFilters instead.", + "type" : "string" + }, + "type" : "array" + }, + "ignored_filters" : { + "description" : "A list of dashboard filters to be ignored for this widget (GAAC).", + "items" : { + "description" : "A list of dashboard filters to be ignored for this widget (GAAC).", + "type" : "string" + }, + "type" : "array" + }, + "interactions" : { + "description" : "Widget interactions (GAAC).", + "items" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "type" : "array" + }, + "layout_direction" : { + "description" : "Layout direction for container widgets.", + "type" : "string" + }, + "metric" : { + "description" : "Inline metric reference.", + "type" : "string" + }, + "rows" : { + "description" : "Widget height in grid rows (GAAC).", + "format" : "int32", + "type" : "integer" + }, + "sections" : { + "description" : "Nested sections for layout widgets.", + "items" : { + "$ref" : "#/components/schemas/AacSection" + }, + "type" : "array" + }, + "size" : { + "$ref" : "#/components/schemas/AacWidgetSize" + }, + "title" : { + "oneOf" : [ { + "type" : "string" + }, { + "enum" : [ false ], + "type" : "boolean" + } ] + }, + "type" : { + "description" : "Widget type.", + "example" : "visualization", + "type" : "string" + }, + "visualization" : { + "description" : "Visualization ID reference.", + "type" : "string" + }, + "visualizations" : { + "description" : "Visualization switcher items.", + "items" : { + "$ref" : "#/components/schemas/AacWidget" + }, + "type" : "array" + }, + "zoom_data" : { + "description" : "Enable zooming to the data for certain visualization types (GAAC).", + "type" : "boolean" + } + }, + "required" : [ "visualization" ], + "type" : "object" + }, + "AacWidget" : { + "description" : "Widgets in the section.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AacVisualizationWidget" + }, { + "$ref" : "#/components/schemas/AacRichTextWidget" + }, { + "$ref" : "#/components/schemas/AacVisualizationSwitcherWidget" + }, { + "$ref" : "#/components/schemas/AacContainerWidget" + } ] + }, + "AacWidgetSize" : { + "description" : "Deprecated widget size (legacy AAC).", + "properties" : { + "height" : { + "description" : "Height in grid rows.", + "format" : "int32", + "type" : "integer" + }, + "height_as_ratio" : { + "description" : "Height definition mode.", + "type" : "boolean" + }, + "width" : { + "description" : "Width in grid columns.", + "format" : "int32", + "type" : "integer" + } + }, + "type" : "object" + }, + "AacWorkspaceDataFilter" : { + "description" : "Workspace data filters.", + "properties" : { + "data_type" : { + "description" : "Data type of the column.", + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "type" : "string" + }, + "filter_id" : { + "description" : "Filter identifier.", + "type" : "string" + }, + "source_column" : { + "description" : "Source column name.", + "type" : "string" + } + }, + "required" : [ "data_type", "filter_id", "source_column" ], + "type" : "object" + }, + "AbsoluteDateFilter" : { + "description" : "A datetime filter specifying exact from and to values.", + "properties" : { + "absoluteDateFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "dataset" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierDataset" + }, + "from" : { + "example" : "2020-07-01 18:23", + "pattern" : "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "type" : "string" + }, + "localIdentifier" : { + "type" : "string" + }, + "to" : { + "example" : "2020-07-16 23:59", + "pattern" : "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", + "type" : "string" + } + }, + "required" : [ "from", "to", "dataset" ], + "type" : "object" + } + }, + "required" : [ "absoluteDateFilter" ], + "type" : "object" + }, + "AbstractMeasureValueFilter" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/ComparisonMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/RangeMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/CompoundMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/RankingFilter" + } ], + "type" : "object" + }, + "AfmIdentifier" : { + "description" : "Reference to the attribute label to which the filter should be applied.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AfmObjectIdentifier" + }, { + "$ref" : "#/components/schemas/AfmLocalIdentifier" + } ], + "type" : "object" + }, + "AfmLocalIdentifier" : { + "properties" : { + "localIdentifier" : { + "example" : "sampleAutoGenerated0123_ID", + "pattern" : "^[.a-zA-Z0-9_-]+$", + "type" : "string" + } + }, + "required" : [ "localIdentifier" ], + "type" : "object" + }, + "AfmObjectIdentifier" : { + "description" : "ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.", + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "enum" : [ "analyticalDashboard", "attribute", "dashboardPlugin", "dataset", "fact", "label", "metric", "prompt", "visualizationObject", "filterContext" ], + "example" : "fact", + "type" : "string" + } }, - "type": "array" - }, - "ignored_filters": { - "description": "A list of dashboard filters to be ignored for this widget (GAAC).", - "items": { - "description": "A list of dashboard filters to be ignored for this widget (GAAC).", - "type": "string" + "required" : [ "type", "id" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AfmObjectIdentifierAttribute" : { + "description" : "Reference to the date attribute to use.", + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "enum" : [ "attribute" ], + "type" : "string" + } }, - "type": "array" - }, - "interactions": { - "description": "Widget interactions (GAAC).", - "items": { - "$ref": "#/components/schemas/JsonNode" + "required" : [ "id", "type" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AfmObjectIdentifierCore" : { + "description" : "Reference to the metric, fact or attribute object to use for the metric.", + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "enum" : [ "attribute", "label", "fact", "metric" ], + "type" : "string" + } }, - "type": "array" - }, - "layout_direction": { - "description": "Layout direction for container widgets.", - "type": "string" - }, - "metric": { - "description": "Inline metric reference.", - "type": "string" - }, - "rows": { - "description": "Widget height in grid rows (GAAC).", - "format": "int32", - "type": "integer" - }, - "sections": { - "description": "Nested sections for layout widgets.", - "items": { - "$ref": "#/components/schemas/AacSection" + "required" : [ "id", "type" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AfmObjectIdentifierDataset" : { + "description" : "Reference to the date dataset to which the filter should be applied.", + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "enum" : [ "dataset" ], + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + } + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AfmObjectIdentifierLabel" : { + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "example" : "sample_item.price", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "enum" : [ "label" ], + "type" : "string" + } }, - "type": "array" - }, - "size": { - "$ref": "#/components/schemas/AacWidgetSize" - }, - "title": { - "oneOf": [ - { - "type": "string" - }, - { - "enum": [ - false - ], - "type": "boolean" - } - ] - }, - "type": { - "description": "Widget type.", - "example": "visualization", - "type": "string" - }, - "visualization": { - "description": "Visualization ID reference.", - "type": "string" - }, - "visualizations": { - "description": "Visualization switcher items.", - "items": { - "$ref": "#/components/schemas/AacWidget" - }, - "type": "array" - }, - "zoom_data": { - "description": "Enable zooming to the data for certain visualization types (GAAC).", - "type": "boolean" - } - }, - "required": [ - "content" - ], - "type": "object" - }, - "AacSection": { - "description": "Sections within the tab.", - "properties": { - "description": { - "description": "Section description.", - "type": "string" - }, - "header": { - "description": "Whether section header is visible.", - "type": "boolean" - }, - "title": { - "description": "Section title.", - "type": "string" - }, - "widgets": { - "description": "Widgets in the section.", - "items": { - "$ref": "#/components/schemas/AacWidget" - }, - "type": "array" - } - }, - "type": "object" - }, - "AacTab": { - "description": "Dashboard tabs (for tabbed dashboards).", - "properties": { - "filters": { - "additionalProperties": { - "$ref": "#/components/schemas/AacDashboardFilter" - }, - "description": "Tab-specific filters.", - "type": "object" - }, - "id": { - "description": "Unique identifier of the tab.", - "type": "string" - }, - "sections": { - "description": "Sections within the tab.", - "items": { - "$ref": "#/components/schemas/AacSection" - }, - "type": "array" - }, - "title": { - "description": "Display title for the tab.", - "type": "string" - } - }, - "required": [ - "id", - "title" - ], - "type": "object" - }, - "AacVisualization": { - "description": "AAC visualization definition.", - "discriminator": { - "mapping": { - "area_chart": "#/components/schemas/AacVisualizationStackedBuckets", - "bar_chart": "#/components/schemas/AacVisualizationStackedBuckets", - "bubble_chart": "#/components/schemas/AacVisualizationBubbleBuckets", - "bullet_chart": "#/components/schemas/AacVisualizationBasicBuckets", - "column_chart": "#/components/schemas/AacVisualizationStackedBuckets", - "combo_chart": "#/components/schemas/AacVisualizationBasicBuckets", - "dependency_wheel_chart": "#/components/schemas/AacVisualizationDependencyBuckets", - "donut_chart": "#/components/schemas/AacVisualizationBasicBuckets", - "funnel_chart": "#/components/schemas/AacVisualizationBasicBuckets", - "geo_area_chart": "#/components/schemas/AacVisualizationGeoBuckets", - "geo_chart": "#/components/schemas/AacVisualizationGeoBuckets", - "headline_chart": "#/components/schemas/AacVisualizationBasicBuckets", - "heatmap_chart": "#/components/schemas/AacVisualizationTableBuckets", - "line_chart": "#/components/schemas/AacVisualizationTrendBuckets", - "pie_chart": "#/components/schemas/AacVisualizationBasicBuckets", - "pyramid_chart": "#/components/schemas/AacVisualizationBasicBuckets", - "repeater_chart": "#/components/schemas/AacVisualizationTableBuckets", - "sankey_chart": "#/components/schemas/AacVisualizationDependencyBuckets", - "scatter_chart": "#/components/schemas/AacVisualizationScatterBuckets", - "table": "#/components/schemas/AacVisualizationTableBuckets", - "treemap_chart": "#/components/schemas/AacVisualizationBasicBuckets", - "waterfall_chart": "#/components/schemas/AacVisualizationBasicBuckets" - }, - "propertyName": "type" - }, - "oneOf": [ - { - "$ref": "#/components/schemas/AacVisualizationTableBuckets" - }, - { - "$ref": "#/components/schemas/AacVisualizationStackedBuckets" - }, - { - "$ref": "#/components/schemas/AacVisualizationScatterBuckets" - }, - { - "$ref": "#/components/schemas/AacVisualizationBubbleBuckets" - }, - { - "$ref": "#/components/schemas/AacVisualizationTrendBuckets" - }, - { - "$ref": "#/components/schemas/AacVisualizationGeoBuckets" - }, - { - "$ref": "#/components/schemas/AacVisualizationBasicBuckets" - }, - { - "$ref": "#/components/schemas/AacVisualizationDependencyBuckets" - } - ] - }, - "AacVisualizationBasicBuckets": { - "allOf": [ - { - "not": { - "required": [ - "rows" - ] - } - }, - { - "not": { - "required": [ - "columns" - ] - } - }, - { - "not": { - "required": [ - "from" - ] - } - }, - { - "not": { - "required": [ - "to" - ] - } - }, - { - "not": { - "required": [ - "stack_by" - ] - } - }, - { - "not": { - "required": [ - "trend_by" - ] - } - }, - { - "not": { - "required": [ - "size_by" - ] - } - }, - { - "not": { - "required": [ - "attributes" - ] - } - }, - { - "not": { - "required": [ - "layers" - ] - } + "required" : [ "type", "id" ], + "type" : "object" } - ], - "properties": { - "additionalProperties": { - "additionalProperties": { - "$ref": "#/components/schemas/JsonNode" + }, + "required" : [ "identifier" ], + "type" : "object" + }, + "AlertAfm" : { + "properties" : { + "attributes" : { + "description" : "Attributes to be used in the computation.", + "items" : { + "$ref" : "#/components/schemas/AttributeItem" }, - "type": "object", - "writeOnly": true + "maximum" : 1, + "type" : "array" }, - "attributes": { - "description": "Attributes bucket (for scatter).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "auxMeasures" : { + "description" : "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", + "items" : { + "$ref" : "#/components/schemas/MeasureItem" }, - "type": "array" + "type" : "array" }, - "columns": { - "description": "Columns bucket (for tables).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "filters" : { + "description" : "Various filter types to filter execution result. For anomaly detection, exactly one dataset is specified in the condition. The AFM may contain multiple date filters for different datasets, but only the date filter matching the dataset from the condition is used for anomaly detection.", + "items" : { + "$ref" : "#/components/schemas/FilterDefinition" }, - "type": "array" - }, - "config": { - "$ref": "#/components/schemas/JsonNode" - }, - "description": { - "description": "Visualization description.", - "type": "string" + "type" : "array" }, - "from": { - "$ref": "#/components/schemas/JsonNode" + "measures" : { + "description" : "Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other.", + "items" : { + "$ref" : "#/components/schemas/MeasureItem" + }, + "maximum" : 2, + "minimum" : 1, + "type" : "array" + } + }, + "required" : [ "filters", "measures" ], + "type" : "object" + }, + "AlertCondition" : { + "description" : "Alert trigger condition.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ComparisonWrapper" + }, { + "$ref" : "#/components/schemas/RangeWrapper" + }, { + "$ref" : "#/components/schemas/RelativeWrapper" + }, { + "$ref" : "#/components/schemas/AnomalyDetectionWrapper" + } ], + "type" : "object" + }, + "AlertConditionOperand" : { + "description" : "Operand of the alert condition.", + "oneOf" : [ { + "$ref" : "#/components/schemas/LocalIdentifier" + }, { + "$ref" : "#/components/schemas/Value" + } ], + "type" : "object" + }, + "AnomalyDetection" : { + "properties" : { + "dataset" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierDataset" }, - "id": { - "description": "Unique identifier of the visualization.", - "example": "sales-by-region", - "type": "string" + "granularity" : { + "description" : "Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).", + "enum" : [ "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], + "type" : "string" }, - "is_hidden": { - "description": "Deprecated. Use showInAiResults instead.", - "type": "boolean" + "measure" : { + "$ref" : "#/components/schemas/LocalIdentifier" }, - "layers": { - "description": "Visualization data layers (for geo charts).", - "items": { - "$ref": "#/components/schemas/AacVisualizationLayer" - }, - "type": "array" + "sensitivity" : { + "description" : "Sensitivity level for anomaly detection", + "enum" : [ "LOW", "MEDIUM", "HIGH" ], + "type" : "string" + } + }, + "required" : [ "dataset", "granularity", "measure", "sensitivity" ], + "type" : "object" + }, + "AnomalyDetectionWrapper" : { + "properties" : { + "anomaly" : { + "$ref" : "#/components/schemas/AnomalyDetection" + } + }, + "required" : [ "anomaly" ], + "type" : "object" + }, + "ApiEntitlement" : { + "properties" : { + "expiry" : { + "format" : "date", + "type" : "string" }, - "metrics": { - "description": "Metrics bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + "name" : { + "enum" : [ "CacheStrategy", "Contract", "CustomTheming", "ExtraCache", "Hipaa", "PdfExports", "UiLocalization", "Tier", "UserCount", "ManagedIdpUserCount", "UnlimitedUsers", "UnlimitedWorkspaces", "WhiteLabeling", "WorkspaceCount", "UserTelemetryDisabled", "AutomationCount", "UnlimitedAutomations", "AutomationRecipientCount", "UnlimitedAutomationRecipients", "DailyScheduledActionCount", "UnlimitedDailyScheduledActions", "DailyAlertActionCount", "UnlimitedDailyAlertActions", "ScheduledActionMinimumRecurrenceMinutes", "FederatedIdentityManagement", "AuditLogging", "ControlledFeatureRollout", "AiLake" ], + "type" : "string" }, - "query": { - "$ref": "#/components/schemas/AacQuery" + "value" : { + "type" : "string" + } + }, + "required" : [ "name" ], + "type" : "object" + }, + "ArithmeticMeasure" : { + "properties" : { + "left" : { + "$ref" : "#/components/schemas/LocalIdentifier" }, - "rows": { - "description": "Rows bucket (for tables).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + "operator" : { + "description" : "Arithmetic operator.\nDIFFERENCE - m₁−m₂ - the difference between two metrics.\nCHANGE - (m₁−m₂)÷m₂ - the relative difference between two metrics.\n", + "enum" : [ "DIFFERENCE", "CHANGE" ], + "type" : "string" }, - "segment_by": { - "description": "Segment by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" + "right" : { + "$ref" : "#/components/schemas/LocalIdentifier" + } + }, + "required" : [ "left", "operator", "right" ], + "type" : "object" + }, + "ArithmeticMeasureDefinition" : { + "description" : "Metric representing arithmetics between other metrics.", + "properties" : { + "arithmeticMeasure" : { + "properties" : { + "measureIdentifiers" : { + "description" : "List of metrics to apply arithmetic operation by chosen operator.", + "items" : { + "$ref" : "#/components/schemas/AfmLocalIdentifier" }, - { - "type": "null" - } - ] + "type" : "array" + }, + "operator" : { + "description" : "Arithmetic operator describing operation between metrics.", + "enum" : [ "SUM", "DIFFERENCE", "MULTIPLICATION", "RATIO", "CHANGE" ], + "example" : "SUM", + "type" : "string" + } }, - "type": "array" - }, - "show_in_ai_results": { - "description": "Whether to show in AI results.", - "type": "boolean" + "required" : [ "measureIdentifiers", "operator" ], + "type" : "object" + } + }, + "required" : [ "arithmeticMeasure" ], + "type" : "object" + }, + "AssigneeIdentifier" : { + "description" : "Identifier of a user or user-group.", + "properties" : { + "id" : { + "type" : "string" }, - "size_by": { - "description": "Size by metrics bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "type" : { + "enum" : [ "user", "userGroup" ], + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "AssigneeRule" : { + "description" : "Identifier of an assignee rule.", + "properties" : { + "type" : { + "enum" : [ "allWorkspaceUsers" ], + "type" : "string" + } + }, + "required" : [ "type" ], + "type" : "object" + }, + "AttributeElements" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/AttributeElementsByRef" + }, { + "$ref" : "#/components/schemas/AttributeElementsByValue" + } ], + "type" : "object" + }, + "AttributeElementsByRef" : { + "properties" : { + "uris" : { + "description" : "List of attribute elements by reference", + "items" : { + "nullable" : true, + "type" : "string" }, - "type": "array" - }, - "stack_by": { - "description": "Stack by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "type" : "array" + } + }, + "required" : [ "uris" ], + "type" : "object" + }, + "AttributeElementsByValue" : { + "properties" : { + "values" : { + "description" : "List of attribute elements by value", + "items" : { + "nullable" : true, + "type" : "string" }, - "type": "array" + "type" : "array" + } + }, + "required" : [ "values" ], + "type" : "object" + }, + "AttributeFilter" : { + "description" : "Abstract filter definition type attributes", + "oneOf" : [ { + "$ref" : "#/components/schemas/NegativeAttributeFilter" + }, { + "$ref" : "#/components/schemas/PositiveAttributeFilter" + } ], + "type" : "object" + }, + "AttributeFilterByDate" : { + "properties" : { + "filterLocalIdentifier" : { + "type" : "string" }, - "tags": { - "description": "Metadata tags.", - "items": { - "description": "Metadata tags.", - "type": "string" + "isCommonDate" : { + "type" : "boolean" + } + }, + "required" : [ "filterLocalIdentifier", "isCommonDate" ], + "type" : "object" + }, + "AttributeFilterElements" : { + "description" : "Filter on specific set of label values.", + "properties" : { + "values" : { + "description" : "Set of label values.", + "example" : [ "value1", "value2" ], + "items" : { + "nullable" : true, + "type" : "string" }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Human readable title.", - "example": "Sales by Region", - "type": "string" - }, - "to": { - "$ref": "#/components/schemas/JsonNode" + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "values" ], + "type" : "object" + }, + "AttributeFilterParent" : { + "properties" : { + "filterLocalIdentifier" : { + "type" : "string" }, - "trend_by": { - "description": "Trend by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + "over" : { + "$ref" : "#/components/schemas/Over" + } + }, + "required" : [ "filterLocalIdentifier", "over" ], + "type" : "object" + }, + "AttributeItem" : { + "properties" : { + "label" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierLabel" }, - "type": { - "enum": [ - "bullet_chart", - "combo_chart", - "donut_chart", - "funnel_chart", - "headline_chart", - "pie_chart", - "pyramid_chart", - "treemap_chart", - "waterfall_chart" - ], - "type": "string" + "localIdentifier" : { + "description" : "Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.", + "example" : "attribute_1", + "pattern" : "^[.a-zA-Z0-9_-]+$", + "type" : "string" }, - "view_by": { - "description": "View by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" - } + "showAllValues" : { + "default" : false, + "description" : "Indicates whether to show all values of given attribute even if the data bound to those values is not available.", + "type" : "boolean" + } }, - "required": [ - "id", - "query", - "type" - ], - "type": "object" + "required" : [ "label", "localIdentifier" ], + "type" : "object" }, - "AacVisualizationBubbleBuckets": { - "allOf": [ - { - "not": { - "required": [ - "rows" - ] - } + "AutomationAlert" : { + "properties" : { + "condition" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/AnomalyDetectionWrapper" + }, { + "$ref" : "#/components/schemas/ComparisonWrapper" + }, { + "$ref" : "#/components/schemas/RangeWrapper" + }, { + "$ref" : "#/components/schemas/RelativeWrapper" + } ] }, - { - "not": { - "required": [ - "columns" - ] - } + "execution" : { + "$ref" : "#/components/schemas/AlertAfm" }, - { - "not": { - "required": [ - "from" - ] - } + "interval" : { + "description" : "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", + "enum" : [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], + "type" : "string" }, - { - "not": { - "required": [ - "to" - ] - } + "trigger" : { + "default" : "ALWAYS", + "description" : "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", + "enum" : [ "ALWAYS", "ONCE", "ONCE_PER_INTERVAL" ], + "type" : "string" + } + }, + "required" : [ "condition", "execution" ], + "type" : "object" + }, + "AutomationDashboardTabularExport" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/DashboardTabularExportRequestV2" + } + }, + "required" : [ "requestPayload" ], + "type" : "object" + }, + "AutomationExternalRecipient" : { + "properties" : { + "email" : { + "description" : "E-mail address to send notifications from.", + "format" : "email", + "type" : "string" + } + }, + "required" : [ "email" ], + "type" : "object" + }, + "AutomationImageExport" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/ImageExportRequest" + } + }, + "required" : [ "requestPayload" ], + "type" : "object" + }, + "AutomationMetadata" : { + "description" : "Additional information for the automation.", + "maxLength" : 250000, + "nullable" : true, + "properties" : { + "visibleFilters" : { + "items" : { + "$ref" : "#/components/schemas/VisibleFilter" + }, + "type" : "array" }, - { - "not": { - "required": [ - "stack_by" - ] - } + "widget" : { + "type" : "string" + } + }, + "type" : "object" + }, + "AutomationRawExport" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/RawExportAutomationRequest" + } + }, + "required" : [ "requestPayload" ], + "type" : "object" + }, + "AutomationSchedule" : { + "properties" : { + "cron" : { + "description" : "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", + "example" : "0 */30 9-17 ? * MON-FRI", + "maxLength" : 255, + "type" : "string" }, - { - "not": { - "required": [ - "trend_by" - ] - } + "cronDescription" : { + "description" : "Human-readable description of the cron expression.", + "readOnly" : true, + "type" : "string" }, - { - "not": { - "required": [ - "attributes" - ] - } + "firstRun" : { + "description" : "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", + "example" : "2025-01-01T12:00:00Z", + "format" : "date-time", + "type" : "string" }, - { - "not": { - "required": [ - "layers" - ] - } + "timezone" : { + "description" : "Timezone in which the schedule is defined.", + "example" : "Europe/Prague", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "cron", "timezone" ], + "type" : "object" + }, + "AutomationSlidesExport" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/SlidesExportRequest" } - ], - "properties": { - "additionalProperties": { - "additionalProperties": { - "$ref": "#/components/schemas/JsonNode" + }, + "required" : [ "requestPayload" ], + "type" : "object" + }, + "AutomationTabularExport" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/TabularExportRequest" + } + }, + "required" : [ "requestPayload" ], + "type" : "object" + }, + "AutomationVisualExport" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/VisualExportRequest" + } + }, + "required" : [ "requestPayload" ], + "type" : "object" + }, + "AvailableAssignees" : { + "properties" : { + "userGroups" : { + "description" : "List of user groups", + "items" : { + "$ref" : "#/components/schemas/UserGroupAssignee" }, - "type": "object", - "writeOnly": true + "type" : "array" }, - "attributes": { - "description": "Attributes bucket (for scatter).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "users" : { + "description" : "List of users", + "items" : { + "$ref" : "#/components/schemas/UserAssignee" }, - "type": "array" + "type" : "array" + } + }, + "required" : [ "userGroups", "users" ], + "type" : "object" + }, + "BoundedFilter" : { + "description" : "Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range.", + "properties" : { + "from" : { + "description" : "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). If null, then start of the range is unbounded.", + "example" : -6, + "format" : "int32", + "nullable" : true, + "type" : "integer" }, - "columns": { - "description": "Columns bucket (for tables).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + "granularity" : { + "description" : "Date granularity specifying particular date attribute in given dimension.", + "enum" : [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], + "example" : "DAY", + "type" : "string" }, - "config": { - "$ref": "#/components/schemas/JsonNode" + "to" : { + "description" : "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.", + "example" : 0, + "format" : "int32", + "nullable" : true, + "type" : "integer" + } + }, + "required" : [ "granularity" ], + "type" : "object" + }, + "ColumnOverride" : { + "description" : "Table column override.", + "properties" : { + "labelTargetColumn" : { + "description" : "Specifies the attribute's column to which this label is associated.", + "example" : "users", + "type" : "string" }, - "description": { - "description": "Visualization description.", - "type": "string" + "labelType" : { + "description" : "Label type for the target attribute.", + "enum" : [ "TEXT", "HYPERLINK", "GEO", "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", "IMAGE" ], + "example" : "HYPERLINK", + "type" : "string" }, - "from": { - "$ref": "#/components/schemas/JsonNode" + "ldmTypeOverride" : { + "description" : "Logical Data Model type for the column.", + "enum" : [ "FACT", "LABEL" ], + "example" : "FACT", + "type" : "string" }, - "id": { - "description": "Unique identifier of the visualization.", - "example": "sales-by-region", - "type": "string" + "name" : { + "description" : "Column name.", + "example" : "column_name", + "type" : "string" + } + }, + "required" : [ "name" ], + "type" : "object" + }, + "Comparison" : { + "properties" : { + "left" : { + "$ref" : "#/components/schemas/LocalIdentifier" }, - "is_hidden": { - "description": "Deprecated. Use showInAiResults instead.", - "type": "boolean" + "operator" : { + "enum" : [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ], + "type" : "string" }, - "layers": { - "description": "Visualization data layers (for geo charts).", - "items": { - "$ref": "#/components/schemas/AacVisualizationLayer" - }, - "type": "array" - }, - "metrics": { - "description": "Metrics bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "right" : { + "$ref" : "#/components/schemas/AlertConditionOperand" + } + }, + "required" : [ "left", "operator", "right" ], + "type" : "object" + }, + "ComparisonCondition" : { + "description" : "Condition that compares the metric value to a given constant value using a comparison operator.", + "properties" : { + "comparison" : { + "properties" : { + "operator" : { + "enum" : [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ], + "example" : "GREATER_THAN", + "type" : "string" + }, + "value" : { + "example" : 100, + "type" : "number" + } }, - "type": "array" - }, - "query": { - "$ref": "#/components/schemas/AacQuery" - }, - "rows": { - "description": "Rows bucket (for tables).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" + "required" : [ "operator", "value" ], + "type" : "object" + } + }, + "required" : [ "comparison" ], + "type" : "object" + }, + "ComparisonMeasureValueFilter" : { + "description" : "Filter the result by comparing specified metric to given constant value, using given comparison operator.", + "properties" : { + "comparisonMeasureValueFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "dimensionality" : { + "description" : "References to the attributes to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - { - "type": "null" - } - ] + "type" : "array" + }, + "localIdentifier" : { + "type" : "string" + }, + "measure" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "operator" : { + "enum" : [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ], + "example" : "GREATER_THAN", + "type" : "string" + }, + "treatNullValuesAs" : { + "description" : "A value that will be substituted for null values in the metric for the comparisons.", + "example" : 0, + "type" : "number" + }, + "value" : { + "example" : 1327, + "type" : "number" + } }, - "type": "array" - }, - "segment_by": { - "description": "Segment by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" + "required" : [ "operator", "value", "measure" ], + "type" : "object" + } + }, + "required" : [ "comparisonMeasureValueFilter" ], + "type" : "object" + }, + "ComparisonWrapper" : { + "properties" : { + "comparison" : { + "$ref" : "#/components/schemas/Comparison" + } + }, + "required" : [ "comparison" ], + "type" : "object" + }, + "CompoundMeasureValueFilter" : { + "description" : "Filter the result by applying multiple comparison and/or range conditions combined with OR logic. If conditions list is empty, no filtering is applied (all rows are returned).", + "properties" : { + "compoundMeasureValueFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "conditions" : { + "description" : "List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned.", + "items" : { + "$ref" : "#/components/schemas/MeasureValueCondition" }, - { - "type": "object" + "type" : "array" + }, + "dimensionality" : { + "description" : "References to the attributes to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" }, - { - "type": "null" - } - ] + "type" : "array" + }, + "localIdentifier" : { + "type" : "string" + }, + "measure" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "treatNullValuesAs" : { + "description" : "A value that will be substituted for null values in the metric for the comparisons.", + "example" : 0, + "type" : "number" + } }, - "type": "array" - }, - "show_in_ai_results": { - "description": "Whether to show in AI results.", - "type": "boolean" + "required" : [ "conditions", "measure" ], + "type" : "object" + } + }, + "required" : [ "compoundMeasureValueFilter" ], + "type" : "object" + }, + "ContentSlideTemplate" : { + "description" : "Settings for content slide.", + "nullable" : true, + "properties" : { + "descriptionField" : { + "example" : "{{dashboardFilters}}", + "nullable" : true, + "type" : "string" }, - "size_by": { - "description": "Size by metrics bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + "footer" : { + "$ref" : "#/components/schemas/RunningSection" }, - "stack_by": { - "description": "Stack by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + "header" : { + "$ref" : "#/components/schemas/RunningSection" + } + }, + "type" : "object" + }, + "CoverSlideTemplate" : { + "description" : "Settings for cover slide.", + "nullable" : true, + "properties" : { + "backgroundImage" : { + "default" : true, + "description" : "Show background image on the slide.", + "type" : "boolean" }, - "tags": { - "description": "Metadata tags.", - "items": { - "description": "Metadata tags.", - "type": "string" - }, - "type": "array", - "uniqueItems": true + "descriptionField" : { + "example" : "Exported at: {{exportedAt}}", + "nullable" : true, + "type" : "string" }, - "title": { - "description": "Human readable title.", - "example": "Sales by Region", - "type": "string" + "footer" : { + "$ref" : "#/components/schemas/RunningSection" }, - "to": { - "$ref": "#/components/schemas/JsonNode" + "header" : { + "$ref" : "#/components/schemas/RunningSection" + } + }, + "type" : "object" + }, + "CustomLabel" : { + "description" : "Custom label object override.", + "properties" : { + "title" : { + "description" : "Override value.", + "type" : "string" + } + }, + "required" : [ "title" ], + "type" : "object" + }, + "CustomMetric" : { + "description" : "Custom metric object override.", + "properties" : { + "format" : { + "description" : "Format override.", + "type" : "string" }, - "trend_by": { - "description": "Trend by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "title" : { + "description" : "Metric title override.", + "type" : "string" + } + }, + "required" : [ "format", "title" ], + "type" : "object" + }, + "CustomOverride" : { + "description" : "Custom cell value overrides (IDs will be replaced with specified values).", + "properties" : { + "labels" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/CustomLabel" }, - "type": "array" + "description" : "Map of CustomLabels with keys used as placeholders in document.", + "type" : "object" }, - "type": { - "enum": [ - "bubble_chart" - ], - "type": "string" - }, - "view_by": { - "description": "View by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" + "metrics" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/CustomMetric" + }, + "description" : "Map of CustomMetrics with keys used as placeholders in document.", + "type" : "object" + } + }, + "type" : "object" + }, + "DashboardAttributeFilter" : { + "properties" : { + "attributeFilter" : { + "properties" : { + "attributeElements" : { + "$ref" : "#/components/schemas/AttributeElements" + }, + "displayForm" : { + "$ref" : "#/components/schemas/IdentifierRef" + }, + "filterElementsBy" : { + "items" : { + "$ref" : "#/components/schemas/AttributeFilterParent" }, - { - "type": "object" + "type" : "array" + }, + "filterElementsByDate" : { + "items" : { + "$ref" : "#/components/schemas/AttributeFilterByDate" }, - { - "type": "null" - } - ] + "type" : "array" + }, + "localIdentifier" : { + "type" : "string" + }, + "negativeSelection" : { + "type" : "boolean" + }, + "selectionMode" : { + "enum" : [ "single", "multi" ], + "type" : "string" + }, + "title" : { + "type" : "string" + }, + "validateElementsBy" : { + "items" : { + "$ref" : "#/components/schemas/IdentifierRef" + }, + "type" : "array" + } }, - "type": "array" + "required" : [ "attributeElements", "displayForm", "negativeSelection" ], + "type" : "object" } }, - "required": [ - "id", - "query", - "type" - ], - "type": "object" + "required" : [ "attributeFilter" ], + "type" : "object" }, - "AacVisualizationDependencyBuckets": { - "allOf": [ - { - "not": { - "required": [ - "rows" - ] - } - }, - { - "not": { - "required": [ - "columns" - ] - } - }, - { - "not": { - "required": [ - "stack_by" - ] - } - }, - { - "not": { - "required": [ - "trend_by" - ] - } + "DashboardDateFilter" : { + "properties" : { + "dateFilter" : { + "properties" : { + "attribute" : { + "$ref" : "#/components/schemas/IdentifierRef" + }, + "boundedFilter" : { + "$ref" : "#/components/schemas/RelativeBoundedDateFilter" + }, + "dataSet" : { + "$ref" : "#/components/schemas/IdentifierRef" + }, + "from" : { + "oneOf" : [ { + "type" : "string" + }, { + "format" : "int32", + "type" : "integer" + } ] + }, + "granularity" : { + "enum" : [ "ALL_TIME_GRANULARITY", "GDC.time.year", "GDC.time.week_us", "GDC.time.week_in_year", "GDC.time.week_in_quarter", "GDC.time.week", "GDC.time.euweek_in_year", "GDC.time.euweek_in_quarter", "GDC.time.quarter", "GDC.time.quarter_in_year", "GDC.time.month", "GDC.time.month_in_quarter", "GDC.time.month_in_year", "GDC.time.day_in_year", "GDC.time.day_in_quarter", "GDC.time.day_in_month", "GDC.time.day_in_week", "GDC.time.day_in_euweek", "GDC.time.date", "GDC.time.hour", "GDC.time.hour_in_day", "GDC.time.minute", "GDC.time.minute_in_hour", "GDC.time.fiscal_month", "GDC.time.fiscal_quarter", "GDC.time.fiscal_year" ], + "type" : "string" + }, + "localIdentifier" : { + "type" : "string" + }, + "to" : { + "oneOf" : [ { + "type" : "string" + }, { + "format" : "int32", + "type" : "integer" + } ] + }, + "type" : { + "enum" : [ "relative", "absolute" ], + "type" : "string" + } + }, + "required" : [ "granularity", "type" ], + "type" : "object" + } + }, + "required" : [ "dateFilter" ], + "type" : "object" + }, + "DashboardExportSettings" : { + "description" : "Additional settings.", + "properties" : { + "exportInfo" : { + "default" : false, + "description" : "If true, the export will contain the information about the export – exported date, dashboard filters, etc.", + "example" : true, + "type" : "boolean" }, - { - "not": { - "required": [ - "size_by" - ] - } + "mergeHeaders" : { + "default" : false, + "description" : "Merge equal headers in neighbouring cells. Used for [XLSX] format only.", + "example" : true, + "type" : "boolean" }, - { - "not": { - "required": [ - "attributes" - ] - } + "pageOrientation" : { + "default" : "PORTRAIT", + "description" : "Set page orientation. (PDF)", + "enum" : [ "PORTRAIT", "LANDSCAPE" ], + "type" : "string" }, - { - "not": { - "required": [ - "layers" - ] - } + "pageSize" : { + "default" : "A4", + "description" : "Set page size. (PDF)", + "enum" : [ "A3", "A4", "LETTER" ], + "type" : "string" } - ], - "properties": { - "additionalProperties": { - "additionalProperties": { - "$ref": "#/components/schemas/JsonNode" + }, + "type" : "object" + }, + "DashboardFilter" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/DashboardAttributeFilter" + }, { + "$ref" : "#/components/schemas/DashboardDateFilter" + } ], + "type" : "object" + }, + "DashboardPermissions" : { + "properties" : { + "rules" : { + "description" : "List of rules", + "items" : { + "$ref" : "#/components/schemas/RulePermission" }, - "type": "object", - "writeOnly": true + "type" : "array" }, - "attributes": { - "description": "Attributes bucket (for scatter).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "userGroups" : { + "description" : "List of user groups", + "items" : { + "$ref" : "#/components/schemas/UserGroupPermission" + }, + "type" : "array" + }, + "users" : { + "description" : "List of users", + "items" : { + "$ref" : "#/components/schemas/UserPermission" + }, + "type" : "array" + } + }, + "required" : [ "rules", "userGroups", "users" ], + "type" : "object" + }, + "DashboardPermissionsAssignment" : { + "description" : "Desired levels of permissions for an assignee.", + "properties" : { + "permissions" : { + "items" : { + "enum" : [ "EDIT", "SHARE", "VIEW" ], + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ "permissions" ], + "type" : "object" + }, + "DashboardSlidesTemplate" : { + "description" : "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable" : true, + "properties" : { + "appliedOn" : { + "description" : "Export types this template applies to.", + "example" : [ "PDF", "PPTX" ], + "items" : { + "enum" : [ "PDF", "PPTX" ], + "type" : "string" }, - "type": "array" + "minItems" : 1, + "type" : "array" }, - "columns": { - "description": "Columns bucket (for tables).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "contentSlide" : { + "$ref" : "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide" : { + "$ref" : "#/components/schemas/CoverSlideTemplate" + }, + "introSlide" : { + "$ref" : "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide" : { + "$ref" : "#/components/schemas/SectionSlideTemplate" + } + }, + "required" : [ "appliedOn" ], + "type" : "object" + }, + "DashboardTabularExportRequestV2" : { + "description" : "Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId).", + "properties" : { + "dashboardFiltersOverride" : { + "description" : "List of filters that will be used instead of the default dashboard filters.", + "items" : { + "$ref" : "#/components/schemas/DashboardFilter" }, - "type": "array" + "type" : "array" }, - "config": { - "$ref": "#/components/schemas/JsonNode" + "dashboardId" : { + "description" : "Dashboard identifier", + "example" : "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type" : "string" }, - "description": { - "description": "Visualization description.", - "type": "string" + "dashboardTabsFiltersOverrides" : { + "additionalProperties" : { + "items" : { + "$ref" : "#/components/schemas/DashboardFilter" + }, + "type" : "array" + }, + "description" : "Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.", + "type" : "object" }, - "from": { - "$ref": "#/components/schemas/JsonNode" + "fileName" : { + "description" : "Filename of downloaded file without extension.", + "example" : "result", + "type" : "string" }, - "id": { - "description": "Unique identifier of the visualization.", - "example": "sales-by-region", - "type": "string" + "format" : { + "description" : "Requested tabular export type.", + "enum" : [ "XLSX", "PDF" ], + "example" : "XLSX", + "type" : "string" }, - "is_hidden": { - "description": "Deprecated. Use showInAiResults instead.", - "type": "boolean" + "settings" : { + "$ref" : "#/components/schemas/DashboardExportSettings" }, - "layers": { - "description": "Visualization data layers (for geo charts).", - "items": { - "$ref": "#/components/schemas/AacVisualizationLayer" + "widgetIds" : { + "description" : "List of widget identifiers to be exported. Note that only one widget is currently supported.", + "items" : { + "type" : "string" }, - "type": "array" + "maxItems" : 1, + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "dashboardId", "fileName", "format" ], + "type" : "object" + }, + "DataSourcePermissionAssignment" : { + "description" : "Data source permission assignments", + "properties" : { + "assigneeIdentifier" : { + "$ref" : "#/components/schemas/AssigneeIdentifier" }, - "metrics": { - "description": "Metrics bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "permissions" : { + "items" : { + "enum" : [ "MANAGE", "USE" ], + "type" : "string" }, - "type": "array" + "type" : "array" + } + }, + "required" : [ "assigneeIdentifier", "permissions" ], + "type" : "object" + }, + "DataSourceTableIdentifier" : { + "description" : "An id of the table. Including ID of data source.", + "example" : { + "dataSourceId" : "my-postgres", + "id" : "customers", + "type" : "DATA_SOURCE" + }, + "properties" : { + "dataSourceId" : { + "description" : "Data source ID.", + "example" : "my-postgres", + "maxLength" : 255, + "type" : "string" }, - "query": { - "$ref": "#/components/schemas/AacQuery" + "id" : { + "description" : "ID of table.", + "example" : "customers", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "path" : { + "description" : "Path to table.", + "example" : [ "table_schema", "table_name" ], + "items" : { + "example" : "table_name", + "type" : "string" + }, + "nullable" : true, + "type" : "array" + }, + "type" : { + "description" : "Data source entity type.", + "enum" : [ "dataSource" ], + "example" : "dataSource", + "type" : "string" + } + }, + "required" : [ "dataSourceId", "id", "type" ], + "type" : "object" + }, + "DatasetGrain" : { + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "attribute", "date" ], + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "DatasetReferenceIdentifier" : { + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "dataset" ], + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "DatasetWorkspaceDataFilterIdentifier" : { + "description" : "Identifier of a workspace data filter.", + "properties" : { + "id" : { + "description" : "Workspace Data Filters ID.", + "example" : "country_id", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Filter type.", + "enum" : [ "workspaceDataFilter" ], + "example" : "workspaceDataFilter", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "DateFilter" : { + "description" : "Abstract filter definition type for dates.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AbsoluteDateFilter" + }, { + "$ref" : "#/components/schemas/RelativeDateFilter" + } ], + "type" : "object" + }, + "DateValue" : { + "properties" : { + "value" : { + "type" : "string" + } + }, + "required" : [ "value" ], + "type" : "object" + }, + "DeclarativeAggregatedFact" : { + "description" : "A dataset fact.", + "properties" : { + "description" : { + "description" : "Fact description.", + "example" : "A number of orders created by the customer - including all orders, even the non-delivered ones.", + "maxLength" : 10000, + "type" : "string" + }, + "id" : { + "description" : "Fact ID.", + "example" : "fact.customer_order_count", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "isNullable" : { + "description" : "Flag indicating whether the associated source column allows null values.", + "example" : false, + "type" : "boolean" + }, + "nullValue" : { + "description" : "Value used in coalesce during joins instead of null.", + "example" : "0", + "type" : "string" + }, + "sourceColumn" : { + "description" : "A name of the source column in the table.", + "example" : "customer_order_count", + "maxLength" : 255, + "type" : "string" + }, + "sourceColumnDataType" : { + "description" : "A type of the source column", + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "example" : "NUMERIC", + "maxLength" : 255, + "type" : "string" + }, + "sourceFactReference" : { + "$ref" : "#/components/schemas/DeclarativeSourceFactReference" + }, + "tags" : { + "description" : "A list of tags.", + "example" : [ "Customers" ], + "items" : { + "description" : "A list of tags.", + "example" : "[\"Customers\"]", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "id", "sourceColumn", "sourceFactReference" ], + "type" : "object" + }, + "DeclarativeAnalyticalDashboard" : { + "properties" : { + "content" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "createdAt" : { + "description" : "Time of the entity creation.", + "example" : "2023-07-20 12:30", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "createdBy" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" + }, + "description" : { + "description" : "Analytical dashboard description.", + "example" : "Period to period comparison of revenues in main sectors.", + "maxLength" : 10000, + "type" : "string" + }, + "id" : { + "description" : "Analytical dashboard ID.", + "example" : "revenues-analysis", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "modifiedAt" : { + "description" : "Time of the last entity modification.", + "example" : "2023-07-20 12:30", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "modifiedBy" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" + }, + "permissions" : { + "description" : "A list of permissions.", + "items" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/DeclarativeAnalyticalDashboardPermissionForAssignee" + }, { + "$ref" : "#/components/schemas/DeclarativeAnalyticalDashboardPermissionForAssigneeRule" + } ] + }, + "type" : "array" + }, + "summary" : { + "description" : "AI-generated summary of the dashboard content", + "maxLength" : 10000, + "type" : "string" + }, + "tags" : { + "description" : "A list of tags.", + "example" : [ "Revenues" ], + "items" : { + "description" : "A list of tags.", + "example" : "[\"Revenues\"]", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Analytical dashboard title.", + "example" : "Revenues analysis", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "content", "id", "title" ], + "type" : "object" + }, + "DeclarativeAnalyticalDashboardExtension" : { + "properties" : { + "id" : { + "description" : "Analytical dashboard ID.", + "example" : "revenues-analysis", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "permissions" : { + "description" : "A list of permissions.", + "items" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/DeclarativeAnalyticalDashboardPermissionForAssignee" + }, { + "$ref" : "#/components/schemas/DeclarativeAnalyticalDashboardPermissionForAssigneeRule" + } ] + }, + "type" : "array" + } + }, + "required" : [ "id", "permissions" ], + "type" : "object" + }, + "DeclarativeAnalyticalDashboardIdentifier" : { + "description" : "An analytical dashboard identifier.", + "properties" : { + "id" : { + "description" : "Identifier of the analytical dashboard.", + "example" : "dashboard123", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "A type.", + "enum" : [ "analyticalDashboard" ], + "example" : "analyticalDashboard", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "DeclarativeAnalyticalDashboardPermissionAssignment" : { + "description" : "Analytical dashboard permission.", + "properties" : { + "name" : { + "description" : "Permission name.", + "enum" : [ "EDIT", "SHARE", "VIEW" ], + "type" : "string" + } + }, + "required" : [ "name" ], + "type" : "object" + }, + "DeclarativeAnalyticalDashboardPermissionForAssignee" : { + "allOf" : [ { + "$ref" : "#/components/schemas/DeclarativeAnalyticalDashboardPermissionAssignment" + }, { + "properties" : { + "assignee" : { + "$ref" : "#/components/schemas/AssigneeIdentifier" + } }, - "rows": { - "description": "Rows bucket (for tables).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "type" : "object" + } ], + "description" : "Analytical dashboard permission for an assignee.", + "required" : [ "assignee", "name" ], + "type" : "object" + }, + "DeclarativeAnalyticalDashboardPermissionForAssigneeRule" : { + "allOf" : [ { + "$ref" : "#/components/schemas/DeclarativeAnalyticalDashboardPermissionAssignment" + }, { + "properties" : { + "assigneeRule" : { + "$ref" : "#/components/schemas/AssigneeRule" + } + }, + "type" : "object" + } ], + "description" : "Analytical dashboard permission for a collection of assignees identified by a rule.", + "required" : [ "assigneeRule", "name" ], + "type" : "object" + }, + "DeclarativeAnalytics" : { + "description" : "Entities describing users' view on data.", + "properties" : { + "analytics" : { + "$ref" : "#/components/schemas/DeclarativeAnalyticsLayer" + } + }, + "type" : "object" + }, + "DeclarativeAnalyticsLayer" : { + "properties" : { + "analyticalDashboardExtensions" : { + "description" : "A list of dashboard permissions assigned to a related dashboard.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeAnalyticalDashboardExtension" + }, + "type" : "array" + }, + "analyticalDashboards" : { + "description" : "A list of analytical dashboards available in the model.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeAnalyticalDashboard" }, - "type": "array" - }, - "segment_by": { - "description": "Segment by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "type" : "array" + }, + "attributeHierarchies" : { + "description" : "A list of attribute hierarchies.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeAttributeHierarchy" }, - "type": "array" + "type" : "array" }, - "show_in_ai_results": { - "description": "Whether to show in AI results.", - "type": "boolean" - }, - "size_by": { - "description": "Size by metrics bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "dashboardPlugins" : { + "description" : "A list of dashboard plugins available in the model.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeDashboardPlugin" + }, + "type" : "array" + }, + "exportDefinitions" : { + "description" : "A list of export definitions.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeExportDefinition" + }, + "type" : "array" + }, + "filterContexts" : { + "description" : "A list of filter contexts available in the model.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeFilterContext" + }, + "type" : "array" + }, + "memoryItems" : { + "description" : "A list of AI memory items available in the workspace.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeMemoryItem" + }, + "type" : "array" + }, + "metrics" : { + "description" : "A list of metrics available in the model.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeMetric" + }, + "type" : "array" + }, + "visualizationObjects" : { + "description" : "A list of visualization objects available in the model.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeVisualizationObject" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "DeclarativeAttribute" : { + "description" : "A dataset attribute.", + "properties" : { + "defaultView" : { + "$ref" : "#/components/schemas/LabelIdentifier" + }, + "description" : { + "description" : "Attribute description.", + "example" : "Customer name including first and last name.", + "maxLength" : 10000, + "type" : "string" + }, + "id" : { + "description" : "Attribute ID.", + "example" : "attr.customers.customer_name", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "isHidden" : { + "description" : "If true, this attribute is hidden from AI search results.", + "example" : false, + "type" : "boolean" + }, + "isNullable" : { + "description" : "Flag indicating whether the associated source column allows null values.", + "example" : false, + "type" : "boolean" + }, + "labels" : { + "description" : "An array of attribute labels.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeLabel" + }, + "type" : "array" + }, + "locale" : { + "description" : "Default locale for primary label.", + "example" : "en-US", + "type" : "string" + }, + "nullValue" : { + "description" : "Value used in coalesce during joins instead of null.", + "example" : "empty_value", + "type" : "string" + }, + "sortColumn" : { + "description" : "Attribute sort column.", + "example" : "customer_name", + "maxLength" : 255, + "type" : "string" + }, + "sortDirection" : { + "description" : "Attribute sort direction.", + "enum" : [ "ASC", "DESC" ], + "example" : "\"ASC\" | \"DESC\"", + "type" : "string" + }, + "sourceColumn" : { + "description" : "A name of the source column that is the primary label", + "example" : "customer_name", + "maxLength" : 255, + "type" : "string" + }, + "sourceColumnDataType" : { + "description" : "A type of the source column", + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "example" : "STRING", + "maxLength" : 255, + "type" : "string" + }, + "tags" : { + "description" : "A list of tags.", + "example" : [ "Customers" ], + "items" : { + "description" : "A list of tags.", + "example" : "[\"Customers\"]", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Attribute title.", + "example" : "Customer Name", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "id", "labels", "sourceColumn", "title" ], + "type" : "object" + }, + "DeclarativeAttributeHierarchy" : { + "properties" : { + "content" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "createdAt" : { + "description" : "Time of the entity creation.", + "example" : "[\"2023-07-20 12:30\"]", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "createdBy" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" + }, + "description" : { + "description" : "Attribute hierarchy object description.", + "example" : "Simple number for total goods in current production.", + "maxLength" : 10000, + "type" : "string" + }, + "id" : { + "description" : "Attribute hierarchy object ID.", + "example" : "hierarchy-1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "modifiedAt" : { + "description" : "Time of the last entity modification.", + "example" : "[\"2023-07-20 12:30\"]", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "modifiedBy" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" + }, + "tags" : { + "description" : "A list of tags.", + "example" : [ "Revenues" ], + "items" : { + "description" : "A list of tags.", + "example" : "[\"Revenues\"]", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Attribute hierarchy object title.", + "example" : "Count of goods", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "content", "id", "title" ], + "type" : "object" + }, + "DeclarativeAutomation" : { + "properties" : { + "alert" : { + "$ref" : "#/components/schemas/AutomationAlert" + }, + "analyticalDashboard" : { + "$ref" : "#/components/schemas/DeclarativeAnalyticalDashboardIdentifier" + }, + "createdAt" : { + "description" : "Time of the entity creation.", + "example" : "2023-07-20 12:30", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "createdBy" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" + }, + "dashboardTabularExports" : { + "items" : { + "$ref" : "#/components/schemas/AutomationDashboardTabularExport" + }, + "type" : "array", + "uniqueItems" : true + }, + "description" : { + "maxLength" : 255, + "type" : "string" + }, + "details" : { + "additionalProperties" : { + "description" : "TODO", + "maxLength" : 10000, + "type" : "string" + }, + "description" : "TODO", + "maxLength" : 10000, + "type" : "object" + }, + "evaluationMode" : { + "default" : "PER_RECIPIENT", + "description" : "Specify automation evaluation mode.", + "enum" : [ "SHARED", "PER_RECIPIENT" ], + "type" : "string" + }, + "exportDefinitions" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeExportDefinitionIdentifier" + }, + "type" : "array", + "uniqueItems" : true + }, + "externalRecipients" : { + "description" : "External recipients of the automation action results.", + "items" : { + "$ref" : "#/components/schemas/AutomationExternalRecipient" }, - "type": "array" + "type" : "array", + "uniqueItems" : true + }, + "id" : { + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "stack_by": { - "description": "Stack by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "imageExports" : { + "items" : { + "$ref" : "#/components/schemas/AutomationImageExport" }, - "type": "array" + "type" : "array", + "uniqueItems" : true }, - "tags": { - "description": "Metadata tags.", - "items": { - "description": "Metadata tags.", - "type": "string" - }, - "type": "array", - "uniqueItems": true + "metadata" : { + "$ref" : "#/components/schemas/AutomationMetadata" }, - "title": { - "description": "Human readable title.", - "example": "Sales by Region", - "type": "string" + "modifiedAt" : { + "description" : "Time of the last entity modification.", + "example" : "2023-07-20 12:30", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" }, - "to": { - "$ref": "#/components/schemas/JsonNode" + "modifiedBy" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" }, - "trend_by": { - "description": "Trend by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + "notificationChannel" : { + "$ref" : "#/components/schemas/DeclarativeNotificationChannelIdentifier" }, - "type": { - "enum": [ - "dependency_wheel_chart", - "sankey_chart" - ], - "type": "string" + "rawExports" : { + "items" : { + "$ref" : "#/components/schemas/AutomationRawExport" + }, + "type" : "array", + "uniqueItems" : true }, - "view_by": { - "description": "View by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "recipients" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" + }, + "type" : "array", + "uniqueItems" : true + }, + "schedule" : { + "$ref" : "#/components/schemas/AutomationSchedule" + }, + "slidesExports" : { + "items" : { + "$ref" : "#/components/schemas/AutomationSlidesExport" }, - "type": "array" - } - }, - "required": [ - "id", - "query", - "type" - ], - "type": "object" - }, - "AacVisualizationGeoBuckets": { - "allOf": [ - { - "not": { - "required": [ - "rows" - ] - } + "type" : "array", + "uniqueItems" : true }, - { - "not": { - "required": [ - "columns" - ] - } + "state" : { + "default" : "ACTIVE", + "description" : "Current state of the automation.", + "enum" : [ "ACTIVE", "PAUSED" ], + "type" : "string" }, - { - "not": { - "required": [ - "from" - ] - } + "tabularExports" : { + "items" : { + "$ref" : "#/components/schemas/AutomationTabularExport" + }, + "type" : "array", + "uniqueItems" : true }, - { - "not": { - "required": [ - "to" - ] - } + "tags" : { + "items" : { + "description" : "A list of tags.", + "example" : "[\"Revenue\",\"Sales\"]", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true }, - { - "not": { - "required": [ - "stack_by" - ] - } + "title" : { + "maxLength" : 255, + "type" : "string" }, - { - "not": { - "required": [ - "trend_by" - ] - } + "visualExports" : { + "items" : { + "$ref" : "#/components/schemas/AutomationVisualExport" + }, + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "DeclarativeColorPalette" : { + "description" : "Color palette and its properties.", + "properties" : { + "content" : { + "$ref" : "#/components/schemas/JsonNode" }, - { - "not": { - "required": [ - "size_by" - ] - } + "id" : { + "type" : "string" }, - { - "not": { - "required": [ - "attributes" - ] - } + "name" : { + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "content", "id", "name" ], + "type" : "object" + }, + "DeclarativeColumn" : { + "description" : "A table column.", + "properties" : { + "dataType" : { + "description" : "Column type", + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "example" : "INT", + "type" : "string" + }, + "description" : { + "description" : "Column description/comment from database", + "example" : "Customer unique identifier", + "maxLength" : 10000, + "type" : "string" + }, + "isNullable" : { + "description" : "Column is nullable", + "type" : "boolean" + }, + "isPrimaryKey" : { + "description" : "Is column part of primary key?", + "type" : "boolean" + }, + "name" : { + "description" : "Column name", + "example" : "customer_id", + "maxLength" : 255, + "pattern" : "^[^\u0000]*$", + "type" : "string" + }, + "referencedTableColumn" : { + "description" : "Referenced table (Foreign key)", + "example" : "customer_id", + "maxLength" : 255, + "type" : "string" + }, + "referencedTableId" : { + "description" : "Referenced table (Foreign key)", + "example" : "customers", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "dataType", "name" ], + "type" : "object" + }, + "DeclarativeCspDirective" : { + "properties" : { + "directive" : { + "maxLength" : 255, + "type" : "string" + }, + "sources" : { + "items" : { + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ "directive", "sources" ], + "type" : "object" + }, + "DeclarativeCustomApplicationSetting" : { + "description" : "Custom application setting and its value.", + "properties" : { + "applicationName" : { + "description" : "The application id", + "example" : "Modeler", + "maxLength" : 255, + "type" : "string" + }, + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { }, + "maxLength" : 250000, + "nullable" : true, + "type" : "object" + }, + "id" : { + "description" : "Custom Application Setting ID.", + "example" : "modeler.demo", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, + "required" : [ "applicationName", "content", "id" ], + "type" : "object" + }, + "DeclarativeCustomGeoCollection" : { + "description" : "A declarative form of custom geo collection.", + "properties" : { + "description" : { + "description" : "Description of the custom geo collection.", + "maxLength" : 10000, + "type" : "string" + }, + "id" : { + "description" : "Custom geo collection ID.", + "example" : "my-geo-collection", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "name" : { + "description" : "Name of the custom geo collection.", + "example" : "My Geo Collection", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "DeclarativeCustomGeoCollections" : { + "description" : "Custom geo collections.", + "properties" : { + "customGeoCollections" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeCustomGeoCollection" + }, + "type" : "array" + } + }, + "required" : [ "customGeoCollections" ], + "type" : "object" + }, + "DeclarativeDashboardPlugin" : { + "properties" : { + "content" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "createdAt" : { + "description" : "Time of the entity creation.", + "example" : "[\"2023-07-20 12:30\"]", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "createdBy" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" + }, + "description" : { + "description" : "Dashboard plugin description.", + "example" : "Three dimensional view of data.", + "maxLength" : 10000, + "type" : "string" + }, + "id" : { + "description" : "Dashboard plugin object ID.", + "example" : "dashboard-plugin-1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "modifiedAt" : { + "description" : "Time of the last entity modification.", + "example" : "[\"2023-07-20 12:30\"]", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "modifiedBy" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" + }, + "tags" : { + "description" : "A list of tags.", + "example" : [ "Revenues" ], + "items" : { + "description" : "A list of tags.", + "example" : "[\"Revenues\"]", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Dashboard plugin object title.", + "example" : "3D map renderer", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "content", "id", "title" ], + "type" : "object" + }, + "DeclarativeDataSource" : { + "description" : "A data source and its properties.", + "properties" : { + "alternativeDataSourceId" : { + "description" : "Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.", + "example" : "pg_local_docker-demo2", + "nullable" : true, + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "authenticationType" : { + "description" : "Type of authentication used to connect to the database.", + "enum" : [ "USERNAME_PASSWORD", "TOKEN", "KEY_PAIR", "CLIENT_SECRET", "ACCESS_TOKEN" ], + "nullable" : true, + "type" : "string" + }, + "cacheStrategy" : { + "description" : "Determines how the results coming from a particular datasource should be cached.\n- ALWAYS: The results from the datasource should be cached normally (the default).\n- NEVER: The results from the datasource should never be cached.", + "enum" : [ "ALWAYS", "NEVER" ], + "type" : "string" + }, + "clientId" : { + "description" : "Id of client with permission to connect to the data source.", + "example" : "client1234", + "maxLength" : 255, + "type" : "string" + }, + "clientSecret" : { + "description" : "The client secret to use to connect to the database providing the data for the data source.", + "maxLength" : 255, + "type" : "string" + }, + "decodedParameters" : { + "items" : { + "$ref" : "#/components/schemas/Parameter" + }, + "type" : "array" + }, + "id" : { + "description" : "Data source ID.", + "example" : "pg_local_docker-demo", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "name" : { + "description" : "Name of the data source.", + "example" : "postgres demo", + "maxLength" : 255, + "type" : "string" + }, + "parameters" : { + "items" : { + "$ref" : "#/components/schemas/Parameter" + }, + "type" : "array" + }, + "password" : { + "description" : "Password for the data-source user, property is never returned back.", + "example" : "*****", + "maxLength" : 255, + "type" : "string" + }, + "permissions" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeDataSourcePermission" + }, + "type" : "array" + }, + "privateKey" : { + "description" : "The private key to use to connect to the database providing the data for the data source.", + "maxLength" : 15000, + "nullable" : true, + "type" : "string" + }, + "privateKeyPassphrase" : { + "description" : "The passphrase used to encrypt the private key.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "schema" : { + "description" : "A scheme/database with the data.", + "example" : "demo", + "maxLength" : 255, + "type" : "string" + }, + "token" : { + "description" : "Token as an alternative to username and password.", + "example" : "Bigquery service account JSON. Encode it using base64!", + "maxLength" : 10000, + "type" : "string" + }, + "type" : { + "description" : "Type of database.", + "enum" : [ "POSTGRESQL", "REDSHIFT", "VERTICA", "SNOWFLAKE", "ADS", "BIGQUERY", "MSSQL", "PRESTO", "DREMIO", "DRILL", "GREENPLUM", "AZURESQL", "SYNAPSESQL", "DATABRICKS", "GDSTORAGE", "CLICKHOUSE", "MYSQL", "MARIADB", "ORACLE", "PINOT", "SINGLESTORE", "MOTHERDUCK", "FLEXCONNECT", "STARROCKS", "ATHENA", "MONGODB", "CRATEDB", "AILAKEHOUSE" ], + "example" : "POSTGRESQL", + "type" : "string" + }, + "url" : { + "description" : "An connection string relevant to type of database.", + "example" : "jdbc:postgresql://postgres:5432/gooddata", + "maxLength" : 255, + "type" : "string" + }, + "username" : { + "description" : "User with permission connect the data source/database.", + "example" : "demo", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "id", "name", "schema", "type" ], + "type" : "object" + }, + "DeclarativeDataSourcePermission" : { + "properties" : { + "assignee" : { + "$ref" : "#/components/schemas/AssigneeIdentifier" + }, + "name" : { + "description" : "Permission name.", + "enum" : [ "MANAGE", "USE" ], + "type" : "string" + } + }, + "required" : [ "assignee", "name" ], + "type" : "object" + }, + "DeclarativeDataSourcePermissions" : { + "description" : "Data source permissions.", + "properties" : { + "permissions" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeDataSourcePermission" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "DeclarativeDataSources" : { + "description" : "A data source and its properties.", + "properties" : { + "dataSources" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeDataSource" + }, + "type" : "array" } - ], - "properties": { - "additionalProperties": { - "additionalProperties": { - "$ref": "#/components/schemas/JsonNode" + }, + "required" : [ "dataSources" ], + "type" : "object" + }, + "DeclarativeDataset" : { + "description" : "A dataset defined by its properties.", + "properties" : { + "aggregatedFacts" : { + "description" : "An array of aggregated facts.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeAggregatedFact" + }, + "type" : "array" + }, + "attributes" : { + "description" : "An array of attributes.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeAttribute" }, - "type": "object", - "writeOnly": true + "type" : "array" + }, + "dataSourceTableId" : { + "$ref" : "#/components/schemas/DataSourceTableIdentifier" }, - "attributes": { - "description": "Attributes bucket (for scatter).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + "description" : { + "description" : "A dataset description.", + "example" : "The customers of ours.", + "maxLength" : 10000, + "type" : "string" }, - "columns": { - "description": "Columns bucket (for tables).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "facts" : { + "description" : "An array of facts.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeFact" }, - "type": "array" + "type" : "array" }, - "config": { - "$ref": "#/components/schemas/JsonNode" + "grain" : { + "description" : "An array of grain identifiers.", + "items" : { + "$ref" : "#/components/schemas/GrainIdentifier" + }, + "type" : "array" }, - "description": { - "description": "Visualization description.", - "type": "string" + "id" : { + "description" : "The Dataset ID. This ID is further used to refer to this instance of dataset.", + "example" : "customers", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "from": { - "$ref": "#/components/schemas/JsonNode" + "precedence" : { + "description" : "Precedence used in aggregate awareness.", + "example" : 0, + "format" : "int32", + "minimum" : 0, + "type" : "integer" }, - "id": { - "description": "Unique identifier of the visualization.", - "example": "sales-by-region", - "type": "string" + "references" : { + "description" : "An array of references.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeReference" + }, + "type" : "array" }, - "is_hidden": { - "description": "Deprecated. Use showInAiResults instead.", - "type": "boolean" + "sql" : { + "$ref" : "#/components/schemas/DeclarativeDatasetSql" }, - "layers": { - "description": "Visualization data layers (for geo charts).", - "items": { - "$ref": "#/components/schemas/AacVisualizationLayer" + "tags" : { + "description" : "A list of tags.", + "example" : [ "Customers" ], + "items" : { + "description" : "A list of tags.", + "example" : "[\"Customers\"]", + "type" : "string" }, - "type": "array" + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "A dataset title.", + "example" : "Customers", + "maxLength" : 255, + "type" : "string" + }, + "workspaceDataFilterColumns" : { + "description" : "An array of columns which are available for match to implicit workspace data filters.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeWorkspaceDataFilterColumn" + }, + "type" : "array" + }, + "workspaceDataFilterReferences" : { + "description" : "An array of explicit workspace data filters.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeWorkspaceDataFilterReferences" + }, + "type" : "array" + } + }, + "required" : [ "grain", "id", "references", "title" ], + "type" : "object" + }, + "DeclarativeDatasetExtension" : { + "description" : "A dataset extension properties.", + "properties" : { + "id" : { + "description" : "The Dataset ID. This ID is further used to refer to this instance of dataset.", + "example" : "customers", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "workspaceDataFilterReferences" : { + "description" : "An array of explicit workspace data filters.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeWorkspaceDataFilterReferences" + }, + "type" : "array" + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "DeclarativeDatasetSql" : { + "description" : "SQL defining this dataset.", + "example" : { + "dataSourceId" : "my-postgres", + "statement" : "SELECT * FROM some_table" + }, + "properties" : { + "dataSourceId" : { + "description" : "Data source ID.", + "example" : "my-postgres", + "type" : "string" + }, + "statement" : { + "description" : "SQL statement.", + "example" : "SELECT * FROM some_table", + "type" : "string" + } + }, + "required" : [ "dataSourceId", "statement" ], + "type" : "object" + }, + "DeclarativeDateDataset" : { + "description" : "A date dataset.", + "properties" : { + "description" : { + "description" : "Date dataset description.", + "example" : "A customer order date", + "maxLength" : 10000, + "type" : "string" + }, + "granularities" : { + "description" : "An array of date granularities. All listed granularities will be available for date dataset.", + "items" : { + "enum" : [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], + "type" : "string" + }, + "type" : "array" + }, + "granularitiesFormatting" : { + "$ref" : "#/components/schemas/GranularitiesFormatting" + }, + "id" : { + "description" : "Date dataset ID.", + "example" : "date", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "tags" : { + "description" : "A list of tags.", + "example" : [ "Customer dates" ], + "items" : { + "description" : "A list of tags.", + "example" : "[\"Customer dates\"]", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Date dataset title.", + "example" : "Date", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "granularities", "granularitiesFormatting", "id", "title" ], + "type" : "object" + }, + "DeclarativeExportDefinition" : { + "properties" : { + "createdAt" : { + "description" : "Time of the entity creation.", + "example" : "[\"2023-07-20 12:30\"]", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "createdBy" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" + }, + "description" : { + "description" : "Export definition object description.", + "example" : "Simple number for total goods in current production.", + "maxLength" : 10000, + "type" : "string" + }, + "id" : { + "description" : "Export definition id.", + "example" : "export-definition-1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "modifiedAt" : { + "description" : "Time of the last entity modification.", + "example" : "[\"2023-07-20 12:30\"]", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "modifiedBy" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" + }, + "requestPayload" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/TabularExportRequest" + }, { + "$ref" : "#/components/schemas/VisualExportRequest" + } ] + }, + "tags" : { + "description" : "A list of tags.", + "example" : [ "Revenues" ], + "items" : { + "description" : "A list of tags.", + "example" : "[\"Revenues\"]", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Export definition object title.", + "example" : "My regular export", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "id", "title" ], + "type" : "object" + }, + "DeclarativeExportDefinitionIdentifier" : { + "description" : "An export definition identifier.", + "properties" : { + "id" : { + "description" : "Export definition identifier.", + "example" : "export123", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "A type.", + "enum" : [ "exportDefinition" ], + "example" : "exportDefinition", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "DeclarativeExportTemplate" : { + "description" : "A declarative form of a particular export template.", + "properties" : { + "dashboardSlidesTemplate" : { + "$ref" : "#/components/schemas/DashboardSlidesTemplate" + }, + "id" : { + "description" : "Identifier of an export template", + "example" : "default-export-template", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "name" : { + "description" : "Name of an export template.", + "example" : "My default export template", + "maxLength" : 255, + "type" : "string" + }, + "widgetSlidesTemplate" : { + "$ref" : "#/components/schemas/WidgetSlidesTemplate" + } + }, + "required" : [ "id", "name" ], + "type" : "object" + }, + "DeclarativeExportTemplates" : { + "description" : "Export templates.", + "properties" : { + "exportTemplates" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeExportTemplate" + }, + "type" : "array" + } + }, + "required" : [ "exportTemplates" ], + "type" : "object" + }, + "DeclarativeFact" : { + "description" : "A dataset fact.", + "properties" : { + "description" : { + "description" : "Fact description.", + "example" : "A number of orders created by the customer - including all orders, even the non-delivered ones.", + "maxLength" : 10000, + "type" : "string" + }, + "id" : { + "description" : "Fact ID.", + "example" : "fact.customer_order_count", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "isHidden" : { + "description" : "If true, this fact is hidden from AI search results.", + "example" : false, + "type" : "boolean" + }, + "isNullable" : { + "description" : "Flag indicating whether the associated source column allows null values.", + "example" : false, + "type" : "boolean" + }, + "nullValue" : { + "description" : "Value used in coalesce during joins instead of null.", + "example" : "0", + "type" : "string" + }, + "sourceColumn" : { + "description" : "A name of the source column in the table.", + "example" : "customer_order_count", + "maxLength" : 255, + "type" : "string" + }, + "sourceColumnDataType" : { + "description" : "A type of the source column", + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "example" : "NUMERIC", + "maxLength" : 255, + "type" : "string" + }, + "tags" : { + "description" : "A list of tags.", + "example" : [ "Customers" ], + "items" : { + "description" : "A list of tags.", + "example" : "[\"Customers\"]", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Fact title.", + "example" : "Customer order count", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "id", "sourceColumn", "title" ], + "type" : "object" + }, + "DeclarativeFilterContext" : { + "properties" : { + "content" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "description" : { + "description" : "Filter Context description.", + "example" : "Filter Context for Sales team.", + "maxLength" : 10000, + "type" : "string" + }, + "id" : { + "description" : "Filter Context ID.", + "example" : "filter-sales", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "tags" : { + "description" : "A list of tags.", + "example" : [ "Revenues" ], + "items" : { + "description" : "A list of tags.", + "example" : "[\"Revenues\"]", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Filter Context title.", + "example" : "Filter Context for Sales team", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "content", "id", "title" ], + "type" : "object" + }, + "DeclarativeFilterView" : { + "properties" : { + "analyticalDashboard" : { + "$ref" : "#/components/schemas/DeclarativeAnalyticalDashboardIdentifier" + }, + "content" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "description" : { + "maxLength" : 255, + "type" : "string" + }, + "id" : { + "description" : "FilterView object ID.", + "example" : "filterView-1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "isDefault" : { + "description" : "Indicator whether the filter view should by applied by default.", + "type" : "boolean" + }, + "tags" : { + "items" : { + "description" : "A list of tags.", + "example" : "[\"Revenue\",\"Sales\"]", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "maxLength" : 255, + "type" : "string" + }, + "user" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" + } + }, + "required" : [ "id", "title" ], + "type" : "object" + }, + "DeclarativeIdentityProvider" : { + "description" : "Notification channels.", + "properties" : { + "customClaimMapping" : { + "additionalProperties" : { + "description" : "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name, urn.gooddata.user_groups [optional]). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", + "maxLength" : 10000, + "type" : "string" + }, + "description" : "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name, urn.gooddata.user_groups [optional]). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", + "maxLength" : 10000, + "type" : "object" + }, + "id" : { + "description" : "FilterView object ID.", + "example" : "filterView-1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "identifiers" : { + "description" : "List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.", + "example" : [ "gooddata.com" ], + "items" : { + "description" : "List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.", + "example" : "[\"gooddata.com\"]", + "type" : "string" + }, + "type" : "array" + }, + "idpType" : { + "description" : "Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", + "enum" : [ "MANAGED_IDP", "FIM_IDP", "DEX_IDP", "CUSTOM_IDP" ], + "type" : "string" + }, + "oauthClientId" : { + "description" : "The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", + "maxLength" : 255, + "type" : "string" + }, + "oauthClientSecret" : { + "description" : "The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.", + "maxLength" : 255, + "type" : "string" + }, + "oauthCustomAuthAttributes" : { + "additionalProperties" : { + "description" : "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength" : 10000, + "type" : "string" + }, + "description" : "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength" : 10000, + "type" : "object" + }, + "oauthCustomScopes" : { + "description" : "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", + "items" : { + "maxLength" : 255, + "type" : "string" + }, + "nullable" : true, + "type" : "array" + }, + "oauthIssuerId" : { + "description" : "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", + "example" : "myOidcProvider", + "maxLength" : 255, + "type" : "string" + }, + "oauthIssuerLocation" : { + "description" : "The location of your OIDC provider. This field is mandatory for OIDC IdP.", + "maxLength" : 255, + "type" : "string" + }, + "oauthSubjectIdClaim" : { + "description" : "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", + "example" : "oid", + "maxLength" : 255, + "type" : "string" + }, + "samlMetadata" : { + "description" : "Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.", + "maxLength" : 15000, + "type" : "string" + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "DeclarativeIdentityProviderIdentifier" : { + "description" : "An Identity Provider identifier.", + "properties" : { + "id" : { + "description" : "Identifier of the identity provider.", + "example" : "gooddata.com", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "A type.", + "enum" : [ "identityProvider" ], + "example" : "identityProvider", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "DeclarativeJwk" : { + "description" : "A declarative form of the JWK.", + "properties" : { + "content" : { + "$ref" : "#/components/schemas/DeclarativeJwkSpecification" + }, + "id" : { + "description" : "JWK object ID.", + "example" : "jwk-1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, + "required" : [ "content", "id" ], + "type" : "object" + }, + "DeclarativeJwkSpecification" : { + "description" : "Declarative specification of the cryptographic key.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DeclarativeRsaSpecification" + } ], + "type" : "object" + }, + "DeclarativeLabel" : { + "description" : "A attribute label.", + "properties" : { + "description" : { + "description" : "Label description.", + "example" : "Customer name", + "maxLength" : 10000, + "type" : "string" + }, + "geoAreaConfig" : { + "$ref" : "#/components/schemas/GeoAreaConfig" + }, + "id" : { + "description" : "Label ID.", + "example" : "label.customer_name", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "isHidden" : { + "description" : "Determines if the label is hidden from AI features.", + "example" : false, + "type" : "boolean" + }, + "isNullable" : { + "description" : "Flag indicating whether the associated source column allows null values.", + "example" : false, + "type" : "boolean" + }, + "locale" : { + "description" : "Default label locale.", + "example" : "en-US", + "type" : "string" + }, + "nullValue" : { + "description" : "Value used in coalesce during joins instead of null.", + "example" : "empty_value", + "type" : "string" + }, + "sourceColumn" : { + "description" : "A name of the source column in the table.", + "example" : "customer_name", + "maxLength" : 255, + "type" : "string" + }, + "sourceColumnDataType" : { + "description" : "A type of the source column", + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "example" : "STRING", + "maxLength" : 255, + "type" : "string" + }, + "tags" : { + "description" : "A list of tags.", + "example" : [ "Customers" ], + "items" : { + "description" : "A list of tags.", + "example" : "[\"Customers\"]", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Label title.", + "example" : "Customer name", + "maxLength" : 255, + "type" : "string" + }, + "translations" : { + "description" : "Other translations.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeLabelTranslation" + }, + "type" : "array" + }, + "valueType" : { + "description" : "Specific type of label", + "enum" : [ "TEXT", "HYPERLINK", "GEO", "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", "IMAGE" ], + "type" : "string" + } + }, + "required" : [ "id", "sourceColumn", "title" ], + "type" : "object" + }, + "DeclarativeLabelTranslation" : { + "description" : "A label translation.", + "properties" : { + "locale" : { + "description" : "Translation locale.", + "example" : "en-US", + "type" : "string" + }, + "sourceColumn" : { + "description" : "Translation source column.", + "example" : "customer_name_en", + "type" : "string" + } + }, + "required" : [ "locale", "sourceColumn" ], + "type" : "object" + }, + "DeclarativeLdm" : { + "description" : "A logical data model (LDM) representation.", + "properties" : { + "datasetExtensions" : { + "description" : "An array containing extensions for datasets defined in parent workspaces.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeDatasetExtension" + }, + "type" : "array" + }, + "datasets" : { + "description" : "An array containing datasets.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeDataset" + }, + "type" : "array" + }, + "dateInstances" : { + "description" : "An array containing date-related datasets.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeDateDataset" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "DeclarativeMemoryItem" : { + "properties" : { + "createdAt" : { + "description" : "Time of the entity creation.", + "example" : "2023-07-20 12:30", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "createdBy" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" + }, + "description" : { + "description" : "Memory item description.", + "example" : "Context about sales data for AI assistant.", + "maxLength" : 10000, + "type" : "string" + }, + "id" : { + "description" : "Memory item ID.", + "example" : "sales-context", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "instruction" : { + "description" : "The text that will be injected into the system prompt.", + "example" : "When discussing sales, always consider quarterly trends.", + "maxLength" : 255, + "type" : "string" + }, + "isDisabled" : { + "description" : "Whether memory item is disabled.", + "example" : false, + "type" : "boolean" + }, + "keywords" : { + "description" : "Set of unique strings used for semantic similarity filtering.", + "items" : { + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "modifiedAt" : { + "description" : "Time of the last entity modification.", + "example" : "2023-07-20 12:30", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "modifiedBy" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" + }, + "strategy" : { + "description" : "Strategy defining when the memory item should be applied", + "enum" : [ "ALWAYS", "AUTO" ], + "example" : "AUTO", + "type" : "string" + }, + "tags" : { + "description" : "A list of tags.", + "example" : [ "AI", "Context" ], + "items" : { + "description" : "A list of tags.", + "example" : "[\"AI\",\"Context\"]", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Memory item title.", + "example" : "Sales Context", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "id", "instruction", "strategy", "title" ], + "type" : "object" + }, + "DeclarativeMetric" : { + "properties" : { + "content" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "createdAt" : { + "description" : "Time of the entity creation.", + "example" : "[\"2023-07-20 12:30\"]", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "createdBy" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" + }, + "description" : { + "description" : "Metric description.", + "example" : "Sales for all the data available.", + "maxLength" : 10000, + "type" : "string" + }, + "id" : { + "description" : "Metric ID.", + "example" : "total-sales", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "isHidden" : { + "description" : "If true, this metric is hidden from AI search results.", + "example" : false, + "type" : "boolean" + }, + "isHiddenFromKda" : { + "description" : "If true, this metric is hidden from key drive analysis.", + "example" : false, + "type" : "boolean" + }, + "modifiedAt" : { + "description" : "Time of the last entity modification.", + "example" : "[\"2023-07-20 12:30\"]", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "modifiedBy" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" + }, + "tags" : { + "description" : "A list of tags.", + "example" : [ "Revenues" ], + "items" : { + "description" : "A list of tags.", + "example" : "[\"Revenues\"]", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Metric title.", + "example" : "Total sales", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "content", "id", "title" ], + "type" : "object" + }, + "DeclarativeModel" : { + "description" : "A data model structured as a set of its attributes.", + "properties" : { + "ldm" : { + "$ref" : "#/components/schemas/DeclarativeLdm" + } + }, + "type" : "object" + }, + "DeclarativeNotificationChannel" : { + "description" : "A declarative form of a particular notification channel.", + "properties" : { + "allowedRecipients" : { + "default" : "INTERNAL", + "description" : "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", + "enum" : [ "CREATOR", "INTERNAL", "EXTERNAL" ], + "type" : "string" + }, + "customDashboardUrl" : { + "description" : "Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are:\n{workspaceId}\n{dashboardId}\n{automationId}\n{asOfDate}\n", + "maxLength" : 255, + "type" : "string" + }, + "dashboardLinkVisibility" : { + "default" : "INTERNAL_ONLY", + "description" : "Dashboard link visibility in notifications.\nHIDDEN - the link will not be included\nINTERNAL_ONLY - only internal users will see the link\nALL - all users will see the link\n", + "enum" : [ "HIDDEN", "INTERNAL_ONLY", "ALL" ], + "type" : "string" + }, + "description" : { + "description" : "Description of a notification channel.", + "example" : "This is a channel", + "maxLength" : 10000, + "type" : "string" + }, + "destination" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultSmtp" + }, { + "$ref" : "#/components/schemas/InPlatform" + }, { + "$ref" : "#/components/schemas/Smtp" + }, { + "$ref" : "#/components/schemas/Webhook" + } ] + }, + "destinationType" : { + "enum" : [ "WEBHOOK", "SMTP", "DEFAULT_SMTP", "IN_PLATFORM" ], + "nullable" : true, + "readOnly" : true, + "type" : "string" + }, + "id" : { + "description" : "Identifier of a notification channel", + "example" : "notification-channel-1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "inPlatformNotification" : { + "default" : "DISABLED", + "description" : "In-platform notifications configuration. No effect if the destination type is IN_PLATFORM.\nDISABLED - in-platform notifications are not sent\nENABLED - in-platform notifications are sent in addition to the regular notifications\n", + "enum" : [ "DISABLED", "ENABLED" ], + "type" : "string" + }, + "name" : { + "description" : "Name of a notification channel.", + "example" : "channel", + "maxLength" : 255, + "type" : "string" + }, + "notificationSource" : { + "description" : "Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are:\n{{workspaceId}}\n{{workspaceName}}\n{{workspaceDescription}}\n{{dashboardId}}\n{{dashboardName}}\n{{dashboardDescription}}\n", + "maxLength" : 10000, + "type" : "string" + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "DeclarativeNotificationChannelIdentifier" : { + "description" : "A notification channel identifier.", + "properties" : { + "id" : { + "description" : "Notification channel identifier.", + "example" : "webhook123", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "metrics": { - "description": "Metrics bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "type" : { + "description" : "A type.", + "enum" : [ "notificationChannel" ], + "example" : "notificationChannel", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "DeclarativeNotificationChannels" : { + "description" : "Notification channels.", + "properties" : { + "notificationChannels" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeNotificationChannel" }, - "type": "array" - }, - "query": { - "$ref": "#/components/schemas/AacQuery" - }, - "rows": { - "description": "Rows bucket (for tables).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "type" : "array" + } + }, + "required" : [ "notificationChannels" ], + "type" : "object" + }, + "DeclarativeOrganization" : { + "description" : "Complete definition of an organization in a declarative form.", + "properties" : { + "customGeoCollections" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeCustomGeoCollection" }, - "type": "array" + "type" : "array" }, - "segment_by": { - "description": "Segment by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "dataSources" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeDataSource" }, - "type": "array" + "type" : "array" }, - "show_in_ai_results": { - "description": "Whether to show in AI results.", - "type": "boolean" + "exportTemplates" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeExportTemplate" + }, + "type" : "array" }, - "size_by": { - "description": "Size by metrics bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "identityProviders" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeIdentityProvider" }, - "type": "array" + "type" : "array" }, - "stack_by": { - "description": "Stack by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "jwks" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeJwk" }, - "type": "array" + "type" : "array" }, - "tags": { - "description": "Metadata tags.", - "items": { - "description": "Metadata tags.", - "type": "string" + "notificationChannels" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeNotificationChannel" }, - "type": "array", - "uniqueItems": true + "type" : "array" }, - "title": { - "description": "Human readable title.", - "example": "Sales by Region", - "type": "string" + "organization" : { + "$ref" : "#/components/schemas/DeclarativeOrganizationInfo" }, - "to": { - "$ref": "#/components/schemas/JsonNode" + "userGroups" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeUserGroup" + }, + "type" : "array" }, - "trend_by": { - "description": "Trend by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "users" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeUser" }, - "type": "array" + "type" : "array" }, - "type": { - "enum": [ - "geo_chart", - "geo_area_chart" - ], - "type": "string" + "workspaceDataFilters" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeWorkspaceDataFilter" + }, + "type" : "array" }, - "view_by": { - "description": "View by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "workspaces" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeWorkspace" }, - "type": "array" + "type" : "array" } }, - "required": [ - "id", - "query", - "type" - ], - "type": "object" + "required" : [ "organization" ], + "type" : "object" }, - "AacVisualizationLayer": { - "description": "Visualization data layers (for geo charts).", - "properties": { - "additionalProperties": { - "additionalProperties": { - "$ref": "#/components/schemas/JsonNode" + "DeclarativeOrganizationInfo" : { + "description" : "Information available about an organization.", + "properties" : { + "allowedOrigins" : { + "items" : { + "type" : "string" }, - "type": "object", - "writeOnly": true + "type" : "array" }, - "config": { - "$ref": "#/components/schemas/JsonNode" + "colorPalettes" : { + "description" : "A list of color palettes.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeColorPalette" + }, + "type" : "array" }, - "filters": { - "additionalProperties": { - "$ref": "#/components/schemas/AacQueryFilter" + "cspDirectives" : { + "description" : "A list of CSP directives.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeCspDirective" }, - "description": "Layer filters.", - "type": "object" + "type" : "array" }, - "id": { - "description": "Unique identifier of the layer.", - "type": "string" + "earlyAccess" : { + "deprecated" : true, + "description" : "Early access defined on level Organization", + "maxLength" : 255, + "type" : "string" }, - "metrics": { - "description": "Layer metrics.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "earlyAccessValues" : { + "description" : "Early access defined on level Organization", + "items" : { + "maxLength" : 255, + "type" : "string" }, - "type": "array" + "type" : "array", + "uniqueItems" : true }, - "segment_by": { - "description": "Layer segment by.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + "hostname" : { + "description" : "Formal hostname used in deployment.", + "example" : "alpha.com", + "maxLength" : 255, + "type" : "string" }, - "sorts": { - "description": "Layer sorting definitions.", - "items": { - "$ref": "#/components/schemas/JsonNode" - }, - "type": "array" + "id" : { + "description" : "Identifier of the organization.", + "example" : "Alpha corporation", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "title": { - "description": "Layer title.", - "type": "string" + "identityProvider" : { + "$ref" : "#/components/schemas/DeclarativeIdentityProviderIdentifier" }, - "type": { - "description": "Layer type.", - "example": "pushpin", - "type": "string" + "name" : { + "description" : "Formal name of the organization.", + "example" : "Alpha corporation", + "maxLength" : 255, + "type" : "string" }, - "view_by": { - "description": "Layer view by.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "permissions" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeOrganizationPermission" + }, + "type" : "array" + }, + "settings" : { + "description" : "A list of organization settings.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeSetting" + }, + "type" : "array" + }, + "themes" : { + "description" : "A list of themes.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeTheme" }, - "type": "array" + "type" : "array" } }, - "required": [ - "id" - ], - "type": "object" + "required" : [ "hostname", "id", "name", "permissions" ], + "type" : "object" }, - "AacVisualizationScatterBuckets": { - "allOf": [ - { - "not": { - "required": [ - "rows" - ] - } + "DeclarativeOrganizationPermission" : { + "description" : "Definition of an organization permission assigned to a user/user-group.", + "properties" : { + "assignee" : { + "$ref" : "#/components/schemas/AssigneeIdentifier" + }, + "name" : { + "description" : "Permission name.", + "enum" : [ "MANAGE", "SELF_CREATE_TOKEN" ], + "type" : "string" + } + }, + "required" : [ "assignee", "name" ], + "type" : "object" + }, + "DeclarativeReference" : { + "description" : "A dataset reference.", + "properties" : { + "identifier" : { + "$ref" : "#/components/schemas/ReferenceIdentifier" + }, + "multivalue" : { + "description" : "The multi-value flag enables many-to-many cardinality for references.", + "example" : false, + "type" : "boolean" + }, + "sourceColumnDataTypes" : { + "deprecated" : true, + "description" : "An array of source column data types for a given reference. Deprecated, use 'sources' instead.", + "items" : { + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "type" : "string" + }, + "type" : "array" + }, + "sourceColumns" : { + "deprecated" : true, + "description" : "An array of source column names for a given reference. Deprecated, use 'sources' instead.", + "example" : [ "customer_id" ], + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "sources" : { + "description" : "An array of source columns for a given reference.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeReferenceSource" + }, + "type" : "array" + } + }, + "required" : [ "identifier", "multivalue" ], + "type" : "object" + }, + "DeclarativeReferenceSource" : { + "description" : "A dataset reference source column description.", + "properties" : { + "column" : { + "description" : "A name of the source column in the table.", + "example" : "customer_id", + "maxLength" : 255, + "type" : "string" + }, + "dataType" : { + "description" : "A type of the source column.", + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "example" : "STRING", + "maxLength" : 255, + "type" : "string" + }, + "isNullable" : { + "description" : "Flag indicating whether the associated source column allows null values.", + "example" : false, + "type" : "boolean" }, - { - "not": { - "required": [ - "columns" - ] - } + "nullValue" : { + "description" : "Value used in coalesce during joins instead of null.", + "example" : "empty_value", + "type" : "string" + }, + "target" : { + "$ref" : "#/components/schemas/GrainIdentifier" + } + }, + "required" : [ "column", "target" ], + "type" : "object" + }, + "DeclarativeRsaSpecification" : { + "description" : "Declarative specification of the cryptographic key.", + "properties" : { + "alg" : { + "description" : "Algorithm intended for use with the key.", + "enum" : [ "RS256", "RS384", "RS512" ], + "example" : "RS256", + "type" : "string" + }, + "e" : { + "description" : "parameter contains the exponent value for the RSA public key.", + "type" : "string" + }, + "kid" : { + "description" : "Parameter is used to match a specific key.", + "example" : "key.001", + "maxLength" : 255, + "pattern" : "^[^.]", + "type" : "string" + }, + "kty" : { + "description" : "Key type parameter", + "enum" : [ "RSA" ], + "example" : "RSA", + "type" : "string" + }, + "n" : { + "description" : "Parameter contains the modulus value for the RSA public key.", + "type" : "string" + }, + "use" : { + "description" : "Parameter identifies the intended use of the public key.", + "enum" : [ "sig" ], + "example" : "sig", + "type" : "string" + }, + "x5c" : { + "description" : "Parameter contains a chain of one or more PKIX certificates.", + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "x5t" : { + "description" : "Parameter is a base64url-encoded SHA-1 thumbprint of the DER encoding of an X.509 certificate.", + "type" : "string" + } + }, + "required" : [ "alg", "e", "kid", "kty", "n", "use" ], + "type" : "object" + }, + "DeclarativeSetting" : { + "description" : "Setting and its value.", + "properties" : { + "content" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "id" : { + "description" : "Setting ID.", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Type of the setting.", + "enum" : [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS" ], + "example" : "TIMEZONE", + "type" : "string" + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "DeclarativeSingleWorkspacePermission" : { + "properties" : { + "assignee" : { + "$ref" : "#/components/schemas/AssigneeIdentifier" + }, + "name" : { + "description" : "Permission name.", + "enum" : [ "MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "CREATE_FILTER_VIEW", "VIEW" ], + "type" : "string" + } + }, + "required" : [ "assignee", "name" ], + "type" : "object" + }, + "DeclarativeSourceFactReference" : { + "description" : "Aggregated awareness source fact reference.", + "properties" : { + "operation" : { + "description" : "Aggregation operation.", + "enum" : [ "SUM", "MIN", "MAX" ], + "example" : "SUM", + "type" : "string" + }, + "reference" : { + "$ref" : "#/components/schemas/FactIdentifier" + } + }, + "required" : [ "operation", "reference" ], + "type" : "object" + }, + "DeclarativeTable" : { + "description" : "A database table.", + "properties" : { + "columns" : { + "description" : "An array of physical columns", + "items" : { + "$ref" : "#/components/schemas/DeclarativeColumn" + }, + "type" : "array" + }, + "id" : { + "description" : "Table id.", + "example" : "customers", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "namePrefix" : { + "description" : "Table or view name prefix used in scan. Will be stripped when generating LDM.", + "example" : "out_gooddata", + "maxLength" : 255, + "type" : "string" + }, + "path" : { + "description" : "Path to table.", + "example" : [ "table_schema", "table_name" ], + "items" : { + "example" : "table_name", + "type" : "string" + }, + "type" : "array" + }, + "type" : { + "description" : "Table type: TABLE or VIEW.", + "example" : "TABLE", + "type" : "string" + } + }, + "required" : [ "columns", "id", "path", "type" ], + "type" : "object" + }, + "DeclarativeTheme" : { + "description" : "Theme and its properties.", + "properties" : { + "content" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "id" : { + "type" : "string" + }, + "name" : { + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "content", "id", "name" ], + "type" : "object" + }, + "DeclarativeUser" : { + "description" : "A user and its properties", + "properties" : { + "authId" : { + "description" : "User identification in the authentication manager.", + "maxLength" : 255, + "type" : "string" + }, + "email" : { + "description" : "User email address", + "example" : "user@example.com", + "maxLength" : 255, + "type" : "string" + }, + "firstname" : { + "description" : "User first name", + "example" : "John", + "maxLength" : 255, + "type" : "string" + }, + "id" : { + "description" : "User identifier.", + "example" : "employee123", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "lastname" : { + "description" : "User last name", + "example" : "Wick", + "maxLength" : 255, + "type" : "string" + }, + "permissions" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeUserPermission" + }, + "type" : "array" + }, + "settings" : { + "description" : "A list of user settings.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeSetting" + }, + "type" : "array" + }, + "userGroups" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeUserGroupIdentifier" + }, + "type" : "array" + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "DeclarativeUserDataFilter" : { + "description" : "User Data Filters serving the filtering of what data users can see in workspaces.", + "properties" : { + "description" : { + "description" : "User Data Filters setting description.", + "example" : "ID of country setting", + "maxLength" : 10000, + "type" : "string" + }, + "id" : { + "description" : "User Data Filters ID. This ID is further used to refer to this instance.", + "example" : "country_id_setting", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - { - "not": { - "required": [ - "from" - ] - } + "maql" : { + "description" : "Expression in MAQL specifying the User Data Filter", + "example" : "{label/country} = \"USA\" AND {label/date.year} = THIS(YEAR)", + "maxLength" : 10000, + "type" : "string" + }, + "tags" : { + "description" : "A list of tags.", + "example" : [ "Revenues" ], + "items" : { + "description" : "A list of tags.", + "example" : "[\"Revenues\"]", + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "User Data Filters setting title.", + "example" : "Country ID setting", + "maxLength" : 255, + "type" : "string" + }, + "user" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" }, - { - "not": { - "required": [ - "to" - ] - } + "userGroup" : { + "$ref" : "#/components/schemas/DeclarativeUserGroupIdentifier" + } + }, + "required" : [ "id", "maql", "title" ], + "type" : "object" + }, + "DeclarativeUserDataFilters" : { + "description" : "Declarative form of user data filters.", + "properties" : { + "userDataFilters" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeUserDataFilter" + }, + "type" : "array" + } + }, + "required" : [ "userDataFilters" ], + "type" : "object" + }, + "DeclarativeUserGroup" : { + "description" : "A user-group and its properties", + "properties" : { + "id" : { + "description" : "UserGroup identifier.", + "example" : "employees.all", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - { - "not": { - "required": [ - "stack_by" - ] - } + "name" : { + "description" : "Name of UserGroup", + "example" : "admins", + "maxLength" : 255, + "type" : "string" }, - { - "not": { - "required": [ - "trend_by" - ] - } + "parents" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeUserGroupIdentifier" + }, + "type" : "array" }, - { - "not": { - "required": [ - "size_by" - ] - } + "permissions" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeUserGroupPermission" + }, + "type" : "array" + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "DeclarativeUserGroupIdentifier" : { + "description" : "A user group identifier.", + "example" : { + "id" : "admins", + "type" : "userGroup" + }, + "properties" : { + "id" : { + "description" : "Identifier of the user group.", + "example" : "group.admins", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - { - "not": { - "required": [ - "layers" - ] - } + "type" : { + "description" : "A type.", + "enum" : [ "userGroup" ], + "example" : "userGroup", + "type" : "string" } - ], - "properties": { - "additionalProperties": { - "additionalProperties": { - "$ref": "#/components/schemas/JsonNode" - }, - "type": "object", - "writeOnly": true + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "DeclarativeUserGroupPermission" : { + "description" : "Definition of a user-group permission assigned to a user/user-group.", + "properties" : { + "assignee" : { + "$ref" : "#/components/schemas/AssigneeIdentifier" }, - "attributes": { - "description": "Attributes bucket (for scatter).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "name" : { + "description" : "Permission name.", + "enum" : [ "SEE" ], + "type" : "string" + } + }, + "required" : [ "assignee", "name" ], + "type" : "object" + }, + "DeclarativeUserGroupPermissions" : { + "description" : "Definition of permissions associated with a user-group.", + "properties" : { + "permissions" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeUserGroupPermission" }, - "type": "array" - }, - "columns": { - "description": "Columns bucket (for tables).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "type" : "array" + } + }, + "type" : "object" + }, + "DeclarativeUserGroups" : { + "description" : "Declarative form of userGroups and its properties.", + "properties" : { + "userGroups" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeUserGroup" }, - "type": "array" - }, - "config": { - "$ref": "#/components/schemas/JsonNode" - }, - "description": { - "description": "Visualization description.", - "type": "string" - }, - "from": { - "$ref": "#/components/schemas/JsonNode" - }, - "id": { - "description": "Unique identifier of the visualization.", - "example": "sales-by-region", - "type": "string" + "type" : "array" + } + }, + "required" : [ "userGroups" ], + "type" : "object" + }, + "DeclarativeUserIdentifier" : { + "description" : "A user identifier.", + "example" : { + "id" : "example123", + "type" : "user" + }, + "properties" : { + "id" : { + "description" : "User identifier.", + "example" : "employee123", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "is_hidden": { - "description": "Deprecated. Use showInAiResults instead.", - "type": "boolean" + "type" : { + "description" : "A type.", + "enum" : [ "user" ], + "example" : "user", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "DeclarativeUserPermission" : { + "description" : "Definition of a user permission assigned to a user/user-group.", + "properties" : { + "assignee" : { + "$ref" : "#/components/schemas/AssigneeIdentifier" }, - "layers": { - "description": "Visualization data layers (for geo charts).", - "items": { - "$ref": "#/components/schemas/AacVisualizationLayer" + "name" : { + "description" : "Permission name.", + "enum" : [ "SEE" ], + "type" : "string" + } + }, + "required" : [ "assignee", "name" ], + "type" : "object" + }, + "DeclarativeUserPermissions" : { + "description" : "Definition of permissions associated with a user.", + "properties" : { + "permissions" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeUserPermission" }, - "type": "array" - }, - "metrics": { - "description": "Metrics bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "type" : "array" + } + }, + "type" : "object" + }, + "DeclarativeUsers" : { + "description" : "Declarative form of users and its properties.", + "properties" : { + "users" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeUser" }, - "type": "array" - }, - "query": { - "$ref": "#/components/schemas/AacQuery" - }, - "rows": { - "description": "Rows bucket (for tables).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "type" : "array" + } + }, + "required" : [ "users" ], + "type" : "object" + }, + "DeclarativeUsersUserGroups" : { + "description" : "Declarative form of both users and user groups and theirs properties.", + "properties" : { + "userGroups" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeUserGroup" }, - "type": "array" + "type" : "array" }, - "segment_by": { - "description": "Segment by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "users" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeUser" }, - "type": "array" - }, - "show_in_ai_results": { - "description": "Whether to show in AI results.", - "type": "boolean" + "type" : "array" + } + }, + "required" : [ "userGroups", "users" ], + "type" : "object" + }, + "DeclarativeVisualizationObject" : { + "properties" : { + "content" : { + "$ref" : "#/components/schemas/JsonNode" }, - "size_by": { - "description": "Size by metrics bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + "createdAt" : { + "description" : "Time of the entity creation.", + "example" : "[\"2023-07-20 12:30\"]", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" }, - "stack_by": { - "description": "Stack by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + "createdBy" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" }, - "tags": { - "description": "Metadata tags.", - "items": { - "description": "Metadata tags.", - "type": "string" - }, - "type": "array", - "uniqueItems": true + "description" : { + "description" : "Visualization object description.", + "example" : "Simple number for total goods in current production.", + "maxLength" : 10000, + "type" : "string" }, - "title": { - "description": "Human readable title.", - "example": "Sales by Region", - "type": "string" + "id" : { + "description" : "Visualization object ID.", + "example" : "visualization-1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "to": { - "$ref": "#/components/schemas/JsonNode" + "isHidden" : { + "description" : "If true, this visualization object is hidden from AI search results.", + "example" : false, + "type" : "boolean" }, - "trend_by": { - "description": "Trend by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + "modifiedAt" : { + "description" : "Time of the last entity modification.", + "example" : "[\"2023-07-20 12:30\"]", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" }, - "type": { - "enum": [ - "scatter_chart" - ], - "type": "string" + "modifiedBy" : { + "$ref" : "#/components/schemas/DeclarativeUserIdentifier" }, - "view_by": { - "description": "View by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "tags" : { + "description" : "A list of tags.", + "example" : [ "Revenues" ], + "items" : { + "description" : "A list of tags.", + "example" : "[\"Revenues\"]", + "type" : "string" }, - "type": "array" + "type" : "array", + "uniqueItems" : true + }, + "title" : { + "description" : "Visualization object title.", + "example" : "Count of goods", + "maxLength" : 255, + "type" : "string" } }, - "required": [ - "id", - "query", - "type" - ], - "type": "object" + "required" : [ "content", "id", "title" ], + "type" : "object" }, - "AacVisualizationStackedBuckets": { - "allOf": [ - { - "not": { - "required": [ - "rows" - ] - } + "DeclarativeWorkspace" : { + "description" : "A declarative form of a particular workspace.", + "properties" : { + "automations" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeAutomation" + }, + "type" : "array" }, - { - "not": { - "required": [ - "columns" - ] - } + "cacheExtraLimit" : { + "description" : "Extra cache limit allocated to specific workspace. In case there is extra cache budget setup for organization, it can be split between multiple workspaces.", + "format" : "int64", + "type" : "integer" }, - { - "not": { - "required": [ - "from" - ] - } + "customApplicationSettings" : { + "description" : "A list of workspace custom settings.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeCustomApplicationSetting" + }, + "type" : "array" + }, + "dataSource" : { + "$ref" : "#/components/schemas/WorkspaceDataSource" + }, + "description" : { + "description" : "Description of the workspace", + "maxLength" : 255, + "type" : "string" + }, + "earlyAccess" : { + "deprecated" : true, + "description" : "Early access defined on level Workspace", + "maxLength" : 255, + "type" : "string" + }, + "earlyAccessValues" : { + "description" : "Early access defined on level Workspace", + "items" : { + "maxLength" : 255, + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "filterViews" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeFilterView" + }, + "type" : "array" + }, + "hierarchyPermissions" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeWorkspaceHierarchyPermission" + }, + "type" : "array" + }, + "id" : { + "description" : "Identifier of a workspace", + "example" : "alpha.sales", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "model" : { + "$ref" : "#/components/schemas/DeclarativeWorkspaceModel" + }, + "name" : { + "description" : "Name of a workspace to view.", + "example" : "Alpha Sales", + "maxLength" : 255, + "type" : "string" + }, + "parent" : { + "$ref" : "#/components/schemas/WorkspaceIdentifier" + }, + "permissions" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeSingleWorkspacePermission" + }, + "type" : "array" + }, + "prefix" : { + "description" : "Custom prefix of entity identifiers in workspace", + "maxLength" : 255, + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - { - "not": { - "required": [ - "to" - ] - } + "settings" : { + "description" : "A list of workspace settings.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeSetting" + }, + "type" : "array" + }, + "userDataFilters" : { + "description" : "A list of workspace user data filters.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeUserDataFilter" + }, + "type" : "array" + } + }, + "required" : [ "id", "name" ], + "type" : "object" + }, + "DeclarativeWorkspaceDataFilter" : { + "description" : "Workspace Data Filters serving the filtering of what data users can see in workspaces.", + "properties" : { + "columnName" : { + "description" : "Workspace Data Filters column name. Data are filtered using this physical column.", + "example" : "country_id", + "maxLength" : 255, + "type" : "string" + }, + "description" : { + "description" : "Workspace Data Filters description.", + "example" : "ID of country", + "maxLength" : 10000, + "type" : "string" + }, + "id" : { + "description" : "Workspace Data Filters ID. This ID is further used to refer to this instance.", + "example" : "country_id", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "title" : { + "description" : "Workspace Data Filters title.", + "example" : "Country ID", + "maxLength" : 255, + "type" : "string" + }, + "workspace" : { + "$ref" : "#/components/schemas/WorkspaceIdentifier" }, - { - "not": { - "required": [ - "trend_by" - ] - } + "workspaceDataFilterSettings" : { + "description" : "Filter settings specifying values of filters valid for the workspace.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeWorkspaceDataFilterSetting" + }, + "type" : "array" + } + }, + "required" : [ "columnName", "id", "title", "workspace", "workspaceDataFilterSettings" ], + "type" : "object" + }, + "DeclarativeWorkspaceDataFilterColumn" : { + "properties" : { + "dataType" : { + "description" : "Data type of the column", + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "example" : "INT", + "type" : "string" }, - { - "not": { - "required": [ - "size_by" - ] - } + "name" : { + "description" : "Name of the column", + "example" : "customer_id", + "type" : "string" + } + }, + "required" : [ "dataType", "name" ], + "type" : "object" + }, + "DeclarativeWorkspaceDataFilterReferences" : { + "properties" : { + "filterColumn" : { + "description" : "Filter column name", + "example" : "filter_id", + "type" : "string" }, - { - "not": { - "required": [ - "attributes" - ] - } + "filterColumnDataType" : { + "description" : "Filter column data type", + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "example" : "INT", + "type" : "string" }, - { - "not": { - "required": [ - "layers" - ] - } + "filterId" : { + "$ref" : "#/components/schemas/DatasetWorkspaceDataFilterIdentifier" } - ], - "properties": { - "additionalProperties": { - "additionalProperties": { - "$ref": "#/components/schemas/JsonNode" - }, - "type": "object", - "writeOnly": true - }, - "attributes": { - "description": "Attributes bucket (for scatter).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + }, + "required" : [ "filterColumn", "filterColumnDataType", "filterId" ], + "type" : "object" + }, + "DeclarativeWorkspaceDataFilterSetting" : { + "description" : "Workspace Data Filters serving the filtering of what data users can see in workspaces.", + "properties" : { + "description" : { + "description" : "Workspace Data Filters setting description.", + "example" : "ID of country setting", + "maxLength" : 10000, + "type" : "string" }, - "columns": { - "description": "Columns bucket (for tables).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "filterValues" : { + "description" : "Only those rows are returned, where columnName from filter matches those values.", + "example" : [ "US" ], + "items" : { + "description" : "Only those rows are returned, where columnName from filter matches those values.", + "example" : "[\"US\"]", + "type" : "string" }, - "type": "array" - }, - "config": { - "$ref": "#/components/schemas/JsonNode" + "type" : "array" }, - "description": { - "description": "Visualization description.", - "type": "string" + "id" : { + "description" : "Workspace Data Filters ID. This ID is further used to refer to this instance.", + "example" : "country_id_setting", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "from": { - "$ref": "#/components/schemas/JsonNode" + "title" : { + "description" : "Workspace Data Filters setting title.", + "example" : "Country ID setting", + "maxLength" : 255, + "type" : "string" }, - "id": { - "description": "Unique identifier of the visualization.", - "example": "sales-by-region", - "type": "string" + "workspace" : { + "$ref" : "#/components/schemas/WorkspaceIdentifier" + } + }, + "required" : [ "filterValues", "id", "title", "workspace" ], + "type" : "object" + }, + "DeclarativeWorkspaceDataFilters" : { + "description" : "Declarative form of data filters.", + "properties" : { + "workspaceDataFilters" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeWorkspaceDataFilter" + }, + "type" : "array" + } + }, + "required" : [ "workspaceDataFilters" ], + "type" : "object" + }, + "DeclarativeWorkspaceHierarchyPermission" : { + "properties" : { + "assignee" : { + "$ref" : "#/components/schemas/AssigneeIdentifier" }, - "is_hidden": { - "description": "Deprecated. Use showInAiResults instead.", - "type": "boolean" + "name" : { + "description" : "Permission name.", + "enum" : [ "MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "CREATE_FILTER_VIEW", "VIEW" ], + "type" : "string" + } + }, + "required" : [ "assignee", "name" ], + "type" : "object" + }, + "DeclarativeWorkspaceModel" : { + "description" : "A declarative form of a model and analytics for a workspace.", + "properties" : { + "analytics" : { + "$ref" : "#/components/schemas/DeclarativeAnalyticsLayer" }, - "layers": { - "description": "Visualization data layers (for geo charts).", - "items": { - "$ref": "#/components/schemas/AacVisualizationLayer" + "ldm" : { + "$ref" : "#/components/schemas/DeclarativeLdm" + } + }, + "type" : "object" + }, + "DeclarativeWorkspacePermissions" : { + "description" : "Definition of permissions associated with a workspace.", + "properties" : { + "hierarchyPermissions" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeWorkspaceHierarchyPermission" }, - "type": "array" + "type" : "array" }, - "metrics": { - "description": "Metrics bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "permissions" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeSingleWorkspacePermission" }, - "type": "array" - }, - "query": { - "$ref": "#/components/schemas/AacQuery" - }, - "rows": { - "description": "Rows bucket (for tables).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "type" : "array" + } + }, + "type" : "object" + }, + "DeclarativeWorkspaces" : { + "description" : "A declarative form of a all workspace layout.", + "properties" : { + "workspaceDataFilters" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeWorkspaceDataFilter" }, - "type": "array" + "type" : "array" }, - "segment_by": { - "description": "Segment by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "workspaces" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeWorkspace" }, - "type": "array" - }, - "show_in_ai_results": { - "description": "Whether to show in AI results.", - "type": "boolean" - }, - "size_by": { - "description": "Size by metrics bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "type" : "array" + } + }, + "required" : [ "workspaceDataFilters", "workspaces" ], + "type" : "object" + }, + "DefaultSmtp" : { + "allOf" : [ { + "properties" : { + "fromEmail" : { + "default" : "no-reply@gooddata.com", + "description" : "E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.", + "format" : "email", + "type" : "string" }, - "type": "array" - }, - "stack_by": { - "description": "Stack by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "fromEmailName" : { + "default" : "GoodData", + "description" : "An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.", + "type" : "string" }, - "type": "array" + "type" : { + "description" : "The destination type.", + "enum" : [ "DEFAULT_SMTP" ], + "type" : "string" + } }, - "tags": { - "description": "Metadata tags.", - "items": { - "description": "Metadata tags.", - "type": "string" + "type" : "object" + } ], + "description" : "Default SMTP destination for notifications.", + "required" : [ "type" ], + "type" : "object" + }, + "DependentEntitiesGraph" : { + "properties" : { + "edges" : { + "items" : { + "items" : { + "$ref" : "#/components/schemas/EntityIdentifier" + }, + "type" : "array" }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Human readable title.", - "example": "Sales by Region", - "type": "string" - }, - "to": { - "$ref": "#/components/schemas/JsonNode" + "type" : "array", + "uniqueItems" : true }, - "trend_by": { - "description": "Trend by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "nodes" : { + "items" : { + "$ref" : "#/components/schemas/DependentEntitiesNode" }, - "type": "array" + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "edges", "nodes" ], + "type" : "object" + }, + "DependentEntitiesNode" : { + "properties" : { + "id" : { + "type" : "string" }, - "type": { - "enum": [ - "bar_chart", - "column_chart", - "area_chart" - ], - "type": "string" + "title" : { + "type" : "string" }, - "view_by": { - "description": "View by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "type" : { + "enum" : [ "analyticalDashboard", "attribute", "attributeHierarchy", "dashboardPlugin", "dataset", "fact", "label", "metric", "userDataFilter", "automation", "memoryItem", "knowledgeRecommendation", "visualizationObject", "filterContext", "filterView" ], + "example" : "metric", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "DependentEntitiesRequest" : { + "properties" : { + "identifiers" : { + "items" : { + "$ref" : "#/components/schemas/EntityIdentifier" }, - "type": "array" + "type" : "array" } }, - "required": [ - "id", - "query", - "type" - ], - "type": "object" + "required" : [ "identifiers" ], + "type" : "object" }, - "AacVisualizationSwitcherWidget": { - "allOf": [ - { - "not": { - "required": [ - "visualization" - ] - } - }, - { - "not": { - "required": [ - "content" - ] - } - }, - { - "not": { - "required": [ - "sections" - ] - } + "DependentEntitiesResponse" : { + "properties" : { + "graph" : { + "$ref" : "#/components/schemas/DependentEntitiesGraph" } - ], - "properties": { - "additionalProperties": { - "additionalProperties": { - "$ref": "#/components/schemas/JsonNode" + }, + "required" : [ "graph" ], + "type" : "object" + }, + "EntitlementsRequest" : { + "properties" : { + "entitlementsName" : { + "items" : { + "enum" : [ "CacheStrategy", "Contract", "CustomTheming", "ExtraCache", "Hipaa", "PdfExports", "UiLocalization", "Tier", "UserCount", "ManagedIdpUserCount", "UnlimitedUsers", "UnlimitedWorkspaces", "WhiteLabeling", "WorkspaceCount", "UserTelemetryDisabled", "AutomationCount", "UnlimitedAutomations", "AutomationRecipientCount", "UnlimitedAutomationRecipients", "DailyScheduledActionCount", "UnlimitedDailyScheduledActions", "DailyAlertActionCount", "UnlimitedDailyAlertActions", "ScheduledActionMinimumRecurrenceMinutes", "FederatedIdentityManagement", "AuditLogging", "ControlledFeatureRollout", "AiLake" ], + "type" : "string" }, - "type": "object", - "writeOnly": true + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "entitlementsName" ], + "type" : "object" + }, + "EntityIdentifier" : { + "properties" : { + "id" : { + "description" : "Object identifier.", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "columns": { - "description": "Widget width in grid columns (GAAC).", - "format": "int32", - "type": "integer" + "type" : { + "enum" : [ "analyticalDashboard", "attribute", "attributeHierarchy", "dashboardPlugin", "dataset", "fact", "label", "metric", "userDataFilter", "automation", "knowledgeRecommendation", "visualizationObject", "filterContext", "filterView" ], + "example" : "metric", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "EntitySearchBody" : { + "description" : "Request body for entity search operations", + "properties" : { + "filter" : { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "nullable" : true, + "type" : "string" }, - "container": { - "description": "Container widget identifier.", - "type": "string" + "include" : { + "description" : "List of related entities to include in the response", + "items" : { + "type" : "string" + }, + "nullable" : true, + "type" : "array" }, - "content": { - "description": "Rich text content.", - "type": "string" + "metaInclude" : { + "description" : "Set of metadata fields to include in the response", + "items" : { + "type" : "string" + }, + "nullable" : true, + "type" : "array", + "uniqueItems" : true }, - "date": { - "description": "Date dataset for filtering.", - "type": "string" + "page" : { + "$ref" : "#/components/schemas/EntitySearchPage" }, - "description": { - "oneOf": [ - { - "type": "string" - }, - { - "enum": [ - false - ], - "type": "boolean" - }, - { - "enum": [ - "inherit" - ], - "type": "string" - } - ] - }, - "drill_down": { - "$ref": "#/components/schemas/JsonNode" - }, - "enable_section_headers": { - "description": "Whether section headers are enabled for container widgets.", - "type": "boolean" - }, - "ignore_dashboard_filters": { - "description": "Deprecated. Use ignoredFilters instead.", - "items": { - "description": "Deprecated. Use ignoredFilters instead.", - "type": "string" - }, - "type": "array" - }, - "ignored_filters": { - "description": "A list of dashboard filters to be ignored for this widget (GAAC).", - "items": { - "description": "A list of dashboard filters to be ignored for this widget (GAAC).", - "type": "string" - }, - "type": "array" - }, - "interactions": { - "description": "Widget interactions (GAAC).", - "items": { - "$ref": "#/components/schemas/JsonNode" - }, - "type": "array" - }, - "layout_direction": { - "description": "Layout direction for container widgets.", - "type": "string" - }, - "metric": { - "description": "Inline metric reference.", - "type": "string" - }, - "rows": { - "description": "Widget height in grid rows (GAAC).", - "format": "int32", - "type": "integer" - }, - "sections": { - "description": "Nested sections for layout widgets.", - "items": { - "$ref": "#/components/schemas/AacSection" - }, - "type": "array" - }, - "size": { - "$ref": "#/components/schemas/AacWidgetSize" - }, - "title": { - "oneOf": [ - { - "type": "string" - }, - { - "enum": [ - false - ], - "type": "boolean" - } - ] - }, - "type": { - "description": "Widget type.", - "example": "visualization", - "type": "string" - }, - "visualization": { - "description": "Visualization ID reference.", - "type": "string" - }, - "visualizations": { - "items": { - "$ref": "#/components/schemas/AacVisualizationWidget" - }, - "type": "array" + "sort" : { + "description" : "Sorting criteria (can specify multiple sort orders)", + "items" : { + "$ref" : "#/components/schemas/EntitySearchSort" + }, + "nullable" : true, + "type" : "array" + } + }, + "type" : "object" + }, + "EntitySearchPage" : { + "description" : "Pagination information for entity search", + "properties" : { + "index" : { + "default" : 0, + "description" : "Zero-based page index", + "format" : "int32", + "minimum" : 0, + "type" : "integer" + }, + "size" : { + "default" : 100, + "description" : "Number of items per page", + "format" : "int32", + "minimum" : 1, + "type" : "integer" + } + }, + "required" : [ "index", "size" ], + "type" : "object" + }, + "EntitySearchSort" : { + "description" : "Sorting criteria for entity search", + "properties" : { + "direction" : { + "default" : "ASC", + "description" : "Sort direction", + "enum" : [ "ASC", "DESC" ], + "type" : "string" + }, + "property" : { + "description" : "Property name to sort by", + "type" : "string" + } + }, + "required" : [ "property" ], + "type" : "object" + }, + "ExecutionSettings" : { + "description" : "Various settings affecting the process of AFM execution or its result", + "properties" : { + "dataSamplingPercentage" : { + "description" : "Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.", + "exclusiveMaximum" : true, + "exclusiveMinimum" : true, + "format" : "float", + "maximum" : 100, + "minimum" : 0, + "type" : "number" + }, + "timestamp" : { + "description" : "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.", + "format" : "date-time", + "type" : "string" + } + }, + "type" : "object" + }, + "ExportRequest" : { + "description" : "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", + "example" : [ "Revenues" ], + "oneOf" : [ { + "$ref" : "#/components/schemas/VisualExportRequest" + }, { + "$ref" : "#/components/schemas/TabularExportRequest" + } ], + "type" : "object" + }, + "FactIdentifier" : { + "description" : "A fact identifier.", + "properties" : { + "id" : { + "description" : "Fact ID.", + "example" : "fact_id", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "zoom_data": { - "description": "Enable zooming to the data for certain visualization types (GAAC).", - "type": "boolean" + "type" : { + "description" : "A type of the fact.", + "enum" : [ "fact" ], + "example" : "fact", + "type" : "string" } }, - "required": [ - "visualizations" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "AacVisualizationTableBuckets": { - "allOf": [ - { - "not": { - "required": [ - "from" - ] - } + "File" : { + "properties" : { + "any" : { + "items" : { + "type" : "object" + }, + "type" : "array" }, - { - "not": { - "required": [ - "to" - ] + "canResegment" : { + "enum" : [ "YES", "NO" ], + "type" : "string", + "xml" : { + "attribute" : true + } + }, + "id" : { + "type" : "string", + "xml" : { + "attribute" : true } }, - { - "not": { - "required": [ - "stack_by" - ] - } + "notes" : { + "$ref" : "#/components/schemas/Notes" }, - { - "not": { - "required": [ - "trend_by" - ] + "original" : { + "type" : "string", + "xml" : { + "attribute" : true } }, - { - "not": { - "required": [ - "size_by" - ] + "otherAttributes" : { + "additionalProperties" : { + "type" : "string" + }, + "type" : "object" + }, + "skeleton" : { + "$ref" : "#/components/schemas/Skeleton" + }, + "space" : { + "type" : "string", + "xml" : { + "attribute" : true, + "namespace" : "http://www.w3.org/XML/1998/namespace" } }, - { - "not": { - "required": [ - "attributes" - ] + "srcDir" : { + "enum" : [ "LTR", "RTL", "AUTO" ], + "type" : "string", + "xml" : { + "attribute" : true } }, - { - "not": { - "required": [ - "layers" - ] + "translate" : { + "enum" : [ "YES", "NO" ], + "type" : "string", + "xml" : { + "attribute" : true } - } - ], - "properties": { - "additionalProperties": { - "additionalProperties": { - "$ref": "#/components/schemas/JsonNode" - }, - "type": "object", - "writeOnly": true }, - "attributes": { - "description": "Attributes bucket (for scatter).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + "trgDir" : { + "enum" : [ "LTR", "RTL", "AUTO" ], + "type" : "string", + "xml" : { + "attribute" : true + } }, - "columns": { - "description": "Columns bucket (for tables).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "unitOrGroup" : { + "items" : { + "type" : "object" }, - "type": "array" - }, - "config": { - "$ref": "#/components/schemas/JsonNode" - }, - "description": { - "description": "Visualization description.", - "type": "string" - }, - "from": { - "$ref": "#/components/schemas/JsonNode" + "type" : "array" + } + }, + "type" : "object", + "xml" : { + "name" : "file", + "namespace" : "urn:oasis:names:tc:xliff:document:2.0" + } + }, + "FilterDefinition" : { + "description" : "Abstract filter definition type", + "oneOf" : [ { + "$ref" : "#/components/schemas/InlineFilterDefinition" + }, { + "$ref" : "#/components/schemas/RankingFilter" + }, { + "$ref" : "#/components/schemas/ComparisonMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/RangeMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/CompoundMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/AbsoluteDateFilter" + }, { + "$ref" : "#/components/schemas/RelativeDateFilter" + }, { + "$ref" : "#/components/schemas/NegativeAttributeFilter" + }, { + "$ref" : "#/components/schemas/PositiveAttributeFilter" + } ], + "type" : "object" + }, + "FilterDefinitionForSimpleMeasure" : { + "description" : "Abstract filter definition type for simple metric.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DateFilter" + }, { + "$ref" : "#/components/schemas/AttributeFilter" + } ], + "type" : "object" + }, + "GenerateLdmRequest" : { + "description" : "A request containing all information needed for generation of logical model.", + "properties" : { + "aggregatedFactPrefix" : { + "description" : "Columns starting with this prefix will be considered as aggregated facts. The prefix is then followed by the value of `separator` parameter. Given the aggregated fact prefix is `aggr` and separator is `__`, the columns with name like `aggr__sum__product__sold` will be considered as aggregated sold fact in the product table with SUM aggregate function.", + "example" : "aggr", + "type" : "string" + }, + "dateGranularities" : { + "description" : "Option to control date granularities for date datasets. Empty value enables common date granularities (DAY, WEEK, MONTH, QUARTER, YEAR). Default value is `all` which enables all available date granularities, including time granularities (like hours, minutes).", + "example" : "all", + "type" : "string" + }, + "dateReferencePrefix" : { + "description" : "Columns starting with this prefix will be considered as references to date dataset. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `d` and separator is `__`, the columns with name like `d__date` will be considered as reference to date dataset. There can be also second separator and granularity suffix, e.g. `d__date__day` to create attribute reference to exact date dataset and granularity.", + "example" : "d", + "type" : "string" + }, + "denormPrefix" : { + "description" : "Columns starting with this prefix will be considered as denormalization references. The prefix is then followed by the value of `separator` parameter. Given the denormalization reference prefix is `dr` and separator is `__`, the columns with name like `dr__customer_name` will be considered as denormalization references.", + "example" : "dr", + "type" : "string" + }, + "factPrefix" : { + "description" : "Columns starting with this prefix will be considered as facts. The prefix is then followed by the value of `separator` parameter. Given the fact prefix is `f` and separator is `__`, the columns with name like `f__sold` will be considered as facts.", + "example" : "f", + "type" : "string" + }, + "generateLongIds" : { + "default" : false, + "description" : "A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of `.` is used. If the flag is set to true, then all ids will be generated in the long form.", + "type" : "boolean" + }, + "grainMultivalueReferencePrefix" : { + "description" : "Columns starting with this prefix will be considered as grain multivalue references. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `grmr` and separator is `__`, the columns with name like `grmr__customer__customer_id` will be considered as grain multivalue references to customer_id in customer table.", + "example" : "grmr", + "type" : "string" + }, + "grainPrefix" : { + "description" : "Columns starting with this prefix will be considered as grains. The prefix is then followed by the value of `separator` parameter. Given the grain prefix is `gr` and separator is `__`, the columns with name like `gr__name` will be considered as grains.", + "example" : "gr", + "type" : "string" + }, + "grainReferencePrefix" : { + "description" : "Columns starting with this prefix will be considered as grain references. The prefix is then followed by the value of `separator` parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is `grr` and separator is `__`, the columns with name like `grr__customer__customer_id` will be considered as grain references to customer_id in customer table.", + "example" : "grr", + "type" : "string" + }, + "multivalueReferencePrefix" : { + "description" : "Columns starting with this prefix will be considered as multivalue references. The prefix is then followed by the value of `separator` parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is `mr` and separator is `__`, the columns with name like `mr__customer__customer_id` will be considered as multivalue references to customer_id in customer table.", + "example" : "mr", + "type" : "string" + }, + "pdm" : { + "$ref" : "#/components/schemas/PdmLdmRequest" + }, + "primaryLabelPrefix" : { + "description" : "Columns starting with this prefix will be considered as primary labels. The prefix is then followed by the value of `separator` parameter. Given the primary label prefix is `pl` and separator is `__`, the columns with name like `pl__country_id` will be considered as primary labels.", + "example" : "pl", + "type" : "string" + }, + "referencePrefix" : { + "description" : "Columns starting with this prefix will be considered as references. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `r` and separator is `__`, the columns with name like `r__customer__customer_id` will be considered as references to customer_id in customer table.", + "example" : "r", + "type" : "string" + }, + "secondaryLabelPrefix" : { + "description" : "Columns starting with this prefix will be considered as secondary labels. The prefix is then followed by the value of `separator` parameter. Given the secondary label prefix is `ls` and separator is `__`, the columns with name like `ls__country_id__country_name` will be considered as secondary labels.", + "example" : "ls", + "type" : "string" + }, + "separator" : { + "default" : "__", + "description" : "A separator between prefixes and the names. Default is \"__\".", + "type" : "string" + }, + "tablePrefix" : { + "deprecated" : true, + "description" : "Tables starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the table prefix is `out_table` and separator is `__`, the table with name like `out_table__customers` will be scanned.", + "example" : "out_table", + "type" : "string" + }, + "translationPrefix" : { + "description" : "Columns starting with this prefix will be considered as secondary label translation. The prefix is then followed by the value of `separator` parameter. Given the translation prefix is `tr` and separator is `__`, the columns with name like `tr__attribute__label__en-US` will be considered as secondary label en-US translation to `label` label in `attribute` attribute.", + "example" : "tr", + "type" : "string" + }, + "viewPrefix" : { + "deprecated" : true, + "description" : "Views starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the view prefix is `out_view` and separator is `__`, the table with name like `out_view__us_customers` will be scanned.", + "example" : "out_view", + "type" : "string" + }, + "wdfPrefix" : { + "default" : "wdf", + "description" : "Column serving as workspace data filter. No labels are auto generated for such columns.", + "type" : "string" + }, + "workspaceId" : { + "description" : "Optional workspace id.", + "type" : "string" + } + }, + "type" : "object" + }, + "GeoAreaConfig" : { + "description" : "Configuration specific to geo area labels.", + "properties" : { + "collection" : { + "$ref" : "#/components/schemas/GeoCollectionIdentifier" + } + }, + "required" : [ "collection" ], + "type" : "object" + }, + "GeoCollectionIdentifier" : { + "properties" : { + "id" : { + "description" : "Geo collection identifier.", + "maxLength" : 255, + "type" : "string" + }, + "kind" : { + "default" : "STATIC", + "description" : "Type of geo collection.", + "enum" : [ "STATIC", "CUSTOM" ], + "type" : "string" + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "GrainIdentifier" : { + "description" : "A grain identifier.", + "example" : { + "id" : "customer_id", + "type" : "attribute" + }, + "maxLength" : 255, + "properties" : { + "id" : { + "description" : "Grain ID.", + "example" : "attr.customers.customer_name", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "id": { - "description": "Unique identifier of the visualization.", - "example": "sales-by-region", - "type": "string" + "type" : { + "description" : "A type of the grain.", + "enum" : [ "attribute", "date" ], + "example" : "ATTRIBUTE", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "GrantedPermission" : { + "description" : "Permissions granted to the user group", + "properties" : { + "level" : { + "description" : "Level of permission", + "example" : "VIEW, SHARE, EDIT", + "type" : "string" + }, + "source" : { + "description" : "Source of permission", + "example" : "direct/indirect", + "type" : "string" + } + }, + "required" : [ "level", "source" ], + "type" : "object" + }, + "GranularitiesFormatting" : { + "description" : "A date dataset granularities title formatting rules.", + "properties" : { + "titleBase" : { + "description" : "Title base is used as a token in title pattern. If left empty, it is replaced by date dataset title.", + "maxLength" : 255, + "type" : "string" }, - "is_hidden": { - "description": "Deprecated. Use showInAiResults instead.", - "type": "boolean" + "titlePattern" : { + "description" : "This pattern is used to generate the title of attributes and labels that result from the granularities.\nThere are two tokens available: \n* `%titleBase` - represents shared part by all titles, or title of Date Dataset if left empty\n* `%granularityTitle` - represents `DateGranularity` built-in title", + "example" : "%titleBase - %granularityTitle", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "titleBase", "titlePattern" ], + "type" : "object" + }, + "HierarchyObjectIdentification" : { + "description" : "Represents objects with given ID and type in workspace hierarchy (more than one can exists in different workspaces).", + "properties" : { + "id" : { + "type" : "string" }, - "layers": { - "description": "Visualization data layers (for geo charts).", - "items": { - "$ref": "#/components/schemas/AacVisualizationLayer" - }, - "type": "array" + "type" : { + "enum" : [ "analyticalDashboard", "attribute", "dashboardPlugin", "dataset", "fact", "label", "metric", "prompt", "visualizationObject", "filterContext", "workspaceDataFilter", "workspaceDataFilterSettings" ], + "example" : "metric", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "IdentifierDuplications" : { + "description" : "Contains information about conflicting IDs in workspace hierarchy", + "properties" : { + "id" : { + "type" : "string" + }, + "origins" : { + "items" : { + "type" : "string" + }, + "type" : "array" }, - "metrics": { - "description": "Metrics bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "type" : { + "enum" : [ "analyticalDashboard", "attribute", "dashboardPlugin", "dataset", "fact", "label", "metric", "prompt", "visualizationObject", "filterContext", "workspaceDataFilter", "workspaceDataFilterSettings" ], + "example" : "metric", + "type" : "string" + } + }, + "required" : [ "id", "origins", "type" ], + "type" : "object" + }, + "IdentifierRef" : { + "properties" : { + "identifier" : { + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "analyticalDashboard", "attribute", "attributeHierarchy", "dashboardPlugin", "dataset", "fact", "aggregatedFact", "label", "metric", "userDataFilter", "exportDefinition", "automation", "automationResult", "memoryItem", "knowledgeRecommendation", "prompt", "visualizationObject", "filterContext", "workspaceSettings", "customApplicationSetting", "workspaceDataFilter", "workspaceDataFilterSetting", "filterView" ], + "type" : "string" + } }, - "type": "array" - }, - "query": { - "$ref": "#/components/schemas/AacQuery" + "required" : [ "id", "type" ], + "type" : "object" + } + }, + "type" : "object" + }, + "ImageExportRequest" : { + "description" : "Export request object describing the export properties and metadata for image exports.", + "properties" : { + "dashboardId" : { + "description" : "Dashboard identifier", + "example" : "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type" : "string" }, - "rows": { - "description": "Rows bucket (for tables).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + "fileName" : { + "description" : "File name to be used for retrieving the image document.", + "example" : "filename", + "type" : "string" }, - "segment_by": { - "description": "Segment by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + "format" : { + "description" : "Requested resulting file type.", + "enum" : [ "PNG" ], + "example" : "PNG", + "type" : "string" }, - "show_in_ai_results": { - "description": "Whether to show in AI results.", - "type": "boolean" + "metadata" : { + "$ref" : "#/components/schemas/JsonNode" }, - "size_by": { - "description": "Size by metrics bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "widgetIds" : { + "description" : "List of widget identifiers to be exported. Note that only one widget is currently supported.", + "items" : { + "maxLength" : 255, + "minLength" : 1, + "type" : "string" }, - "type": "array" + "maxItems" : 1, + "minItems" : 1, + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "dashboardId", "fileName", "format", "widgetIds" ], + "type" : "object" + }, + "InPlatform" : { + "allOf" : [ { + "properties" : { + "type" : { + "description" : "The destination type.", + "enum" : [ "IN_PLATFORM" ], + "type" : "string" + } }, - "stack_by": { - "description": "Stack by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] + "type" : "object" + } ], + "description" : "In-platform destination for notifications.", + "required" : [ "type" ], + "type" : "object" + }, + "InlineFilterDefinition" : { + "description" : "Filter in form of direct MAQL query.", + "properties" : { + "inline" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "filter" : { + "description" : "MAQL query representing the filter.", + "type" : "string" + }, + "localIdentifier" : { + "type" : "string" + } }, - "type": "array" - }, - "tags": { - "description": "Metadata tags.", - "items": { - "description": "Metadata tags.", - "type": "string" + "required" : [ "filter" ], + "type" : "object" + } + }, + "required" : [ "inline" ], + "type" : "object" + }, + "InlineMeasureDefinition" : { + "description" : "Metric defined by the raw MAQL query.", + "properties" : { + "inline" : { + "properties" : { + "maql" : { + "description" : "MAQL query defining the metric.", + "type" : "string" + } }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Human readable title.", - "example": "Sales by Region", - "type": "string" + "required" : [ "maql" ], + "type" : "object" + } + }, + "required" : [ "inline" ], + "type" : "object" + }, + "IntroSlideTemplate" : { + "description" : "Settings for intro slide.", + "nullable" : true, + "properties" : { + "backgroundImage" : { + "default" : true, + "description" : "Show background image on the slide.", + "type" : "boolean" }, - "to": { - "$ref": "#/components/schemas/JsonNode" + "descriptionField" : { + "example" : "About:\n{{dashboardDescription}}\n\n{{dashboardFilters}}", + "nullable" : true, + "type" : "string" }, - "trend_by": { - "description": "Trend by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + "footer" : { + "$ref" : "#/components/schemas/RunningSection" }, - "type": { - "enum": [ - "table", - "heatmap_chart", - "repeater_chart" - ], - "type": "string" + "header" : { + "$ref" : "#/components/schemas/RunningSection" }, - "view_by": { - "description": "View by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "type": "array" + "titleField" : { + "example" : "Introduction", + "nullable" : true, + "type" : "string" } }, - "required": [ - "id", - "query", - "type" - ], - "type": "object" + "type" : "object" }, - "AacVisualizationTrendBuckets": { - "allOf": [ - { - "not": { - "required": [ - "rows" - ] - } + "JsonApiAggregatedFactLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" }, - { - "not": { - "required": [ - "columns" - ] - } - }, - { - "not": { - "required": [ - "from" - ] - } - }, - { - "not": { - "required": [ - "to" - ] - } - }, - { - "not": { - "required": [ - "stack_by" - ] - } - }, - { - "not": { - "required": [ - "size_by" - ] - } - }, - { - "not": { - "required": [ - "attributes" - ] - } - }, - { - "not": { - "required": [ - "layers" - ] - } + "type" : { + "enum" : [ "aggregatedFact" ], + "type" : "string" } - ], - "properties": { - "additionalProperties": { - "additionalProperties": { - "$ref": "#/components/schemas/JsonNode" + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiAggregatedFactOut" : { + "description" : "JSON:API representation of aggregatedFact entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "isNullable" : { + "type" : "boolean" + }, + "nullValue" : { + "type" : "string" + }, + "operation" : { + "enum" : [ "SUM", "MIN", "MAX" ], + "type" : "string" + }, + "sourceColumn" : { + "maxLength" : 255, + "type" : "string" + }, + "sourceColumnDataType" : { + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + } }, - "type": "object", - "writeOnly": true + "required" : [ "operation" ], + "type" : "object" }, - "attributes": { - "description": "Attributes bucket (for scatter).", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" + }, + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" + } }, - { - "type": "null" - } - ] + "required" : [ "originId", "originType" ], + "type" : "object" + } }, - "type": "array" + "type" : "object" }, - "columns": { - "description": "Columns bucket (for tables).", - "items": { - "oneOf": [ - { - "type": "string" + "relationships" : { + "properties" : { + "dataset" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDatasetToOneLinkage" + } }, - { - "type": "object" + "required" : [ "data" ], + "type" : "object" + }, + "sourceFact" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiFactToOneLinkage" + } }, - { - "type": "null" - } - ] + "required" : [ "data" ], + "type" : "object" + } }, - "type": "array" + "type" : "object" }, - "config": { - "$ref": "#/components/schemas/JsonNode" + "type" : { + "description" : "Object type", + "enum" : [ "aggregatedFact" ], + "example" : "aggregatedFact", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiAggregatedFactOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAggregatedFactOut" }, - "description": { - "description": "Visualization description.", - "type": "string" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiAggregatedFactOutIncludes" + }, + "type" : "array", + "uniqueItems" : true }, - "from": { - "$ref": "#/components/schemas/JsonNode" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiAggregatedFactOutIncludes" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiDatasetOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiFactOutWithLinks" + } ] + }, + "JsonApiAggregatedFactOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiAggregatedFactOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true }, - "id": { - "description": "Unique identifier of the visualization.", - "example": "sales-by-region", - "type": "string" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiAggregatedFactOutIncludes" + }, + "type" : "array", + "uniqueItems" : true }, - "is_hidden": { - "description": "Deprecated. Use showInAiResults instead.", - "type": "boolean" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "layers": { - "description": "Visualization data layers (for geo charts).", - "items": { - "$ref": "#/components/schemas/AacVisualizationLayer" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } }, - "type": "array" - }, - "metrics": { - "description": "Metrics bucket.", - "items": { - "oneOf": [ - { - "type": "string" + "type" : "object" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiAggregatedFactOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiAggregatedFactOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiAggregatedFactToManyLinkage" : { + "description" : "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items" : { + "$ref" : "#/components/schemas/JsonApiAggregatedFactLinkage" + }, + "type" : "array" + }, + "JsonApiAnalyticalDashboardIn" : { + "description" : "JSON:API representation of analyticalDashboard entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { + "identifier" : { + "id" : "label.leaf", + "type" : "label" + }, + "someBoolProp" : false }, - { - "type": "object" + "type" : "object" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "summary" : { + "description" : "AI-generated summary of the dashboard content", + "maxLength" : 10000, + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" }, - { - "type": "null" - } - ] + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } }, - "type": "array" + "required" : [ "content" ], + "type" : "object" }, - "query": { - "$ref": "#/components/schemas/AacQuery" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "analyticalDashboard" ], + "example" : "analyticalDashboard", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiAnalyticalDashboardInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiAnalyticalDashboardLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" }, - "rows": { - "description": "Rows bucket (for tables).", - "items": { - "oneOf": [ - { - "type": "string" + "type" : { + "enum" : [ "analyticalDashboard" ], + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiAnalyticalDashboardOut" : { + "description" : "JSON:API representation of analyticalDashboard entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { + "identifier" : { + "id" : "label.leaf", + "type" : "label" + }, + "someBoolProp" : false + }, + "type" : "object" + }, + "createdAt" : { + "description" : "Time of the entity creation.", + "format" : "date-time", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "modifiedAt" : { + "description" : "Time of the last entity modification.", + "format" : "date-time", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "summary" : { + "description" : "AI-generated summary of the dashboard content", + "maxLength" : 10000, + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "content" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "meta" : { + "properties" : { + "accessInfo" : { + "properties" : { + "private" : { + "description" : "is the entity private to the currently logged-in user", + "type" : "boolean" + } + }, + "required" : [ "private" ], + "type" : "object" + }, + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" + }, + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" + } }, - { - "type": "object" + "required" : [ "originId", "originType" ], + "type" : "object" + }, + "permissions" : { + "description" : "List of valid permissions for a logged-in user.", + "items" : { + "enum" : [ "EDIT", "SHARE", "VIEW" ], + "type" : "string" }, - { - "type": "null" - } - ] + "type" : "array" + } }, - "type": "array" + "type" : "object" }, - "segment_by": { - "description": "Segment by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" + "relationships" : { + "properties" : { + "analyticalDashboards" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardToManyLinkage" + } }, - { - "type": "object" + "required" : [ "data" ], + "type" : "object" + }, + "createdBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } }, - { - "type": "null" - } - ] - }, - "type": "array" - }, - "show_in_ai_results": { - "description": "Whether to show in AI results.", - "type": "boolean" - }, - "size_by": { - "description": "Size by metrics bucket.", - "items": { - "oneOf": [ - { - "type": "string" + "required" : [ "data" ], + "type" : "object" + }, + "dashboardPlugins" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginToManyLinkage" + } }, - { - "type": "object" + "required" : [ "data" ], + "type" : "object" + }, + "datasets" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDatasetToManyLinkage" + } }, - { - "type": "null" - } - ] - }, - "type": "array" - }, - "stack_by": { - "description": "Stack by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" + "required" : [ "data" ], + "type" : "object" + }, + "filterContexts" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiFilterContextToManyLinkage" + } }, - { - "type": "object" + "required" : [ "data" ], + "type" : "object" + }, + "labels" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiLabelToManyLinkage" + } }, - { - "type": "null" - } - ] - }, - "type": "array" - }, - "tags": { - "description": "Metadata tags.", - "items": { - "description": "Metadata tags.", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Human readable title.", - "example": "Sales by Region", - "type": "string" - }, - "to": { - "$ref": "#/components/schemas/JsonNode" - }, - "trend_by": { - "description": "Trend by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" + "required" : [ "data" ], + "type" : "object" + }, + "metrics" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiMetricToManyLinkage" + } }, - { - "type": "object" + "required" : [ "data" ], + "type" : "object" + }, + "modifiedBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } }, - { - "type": "null" - } - ] + "required" : [ "data" ], + "type" : "object" + }, + "visualizationObjects" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } }, - "type": "array" + "type" : "object" }, - "type": { - "enum": [ - "line_chart" - ], - "type": "string" - }, - "view_by": { - "description": "View by attributes bucket.", - "items": { - "oneOf": [ - { - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "analyticalDashboard" ], + "example" : "analyticalDashboard", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiAnalyticalDashboardOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOut" + }, + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutIncludes" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiAnalyticalDashboardOutIncludes" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiLabelOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiMetricOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiDatasetOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiFilterContextOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiDashboardPluginOutWithLinks" + } ] + }, + "JsonApiAnalyticalDashboardOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutIncludes" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } + }, + "type" : "object" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiAnalyticalDashboardOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiAnalyticalDashboardPatch" : { + "description" : "JSON:API representation of patching analyticalDashboard entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { + "identifier" : { + "id" : "label.leaf", + "type" : "label" + }, + "someBoolProp" : false }, - { - "type": "object" + "type" : "object" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "summary" : { + "description" : "AI-generated summary of the dashboard content", + "maxLength" : 10000, + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" }, - { - "type": "null" - } - ] + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } }, - "type": "array" + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "analyticalDashboard" ], + "example" : "analyticalDashboard", + "type" : "string" } }, - "required": [ - "id", - "query", - "type" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "AacVisualizationWidget": { - "allOf": [ - { - "not": { - "required": [ - "content" - ] - } - }, - { - "not": { - "required": [ - "sections" - ] - } - }, - { - "not": { - "required": [ - "visualizations" - ] - } + "JsonApiAnalyticalDashboardPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardPatch" } - ], - "properties": { - "additionalProperties": { - "additionalProperties": { - "$ref": "#/components/schemas/JsonNode" - }, - "type": "object", - "writeOnly": true - }, - "columns": { - "description": "Widget width in grid columns (GAAC).", - "format": "int32", - "type": "integer" - }, - "container": { - "description": "Container widget identifier.", - "type": "string" - }, - "content": { - "description": "Rich text content.", - "type": "string" - }, - "date": { - "description": "Date dataset for filtering.", - "type": "string" - }, - "description": { - "oneOf": [ - { - "type": "string" + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiAnalyticalDashboardPostOptionalId" : { + "description" : "JSON:API representation of analyticalDashboard entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { + "identifier" : { + "id" : "label.leaf", + "type" : "label" + }, + "someBoolProp" : false + }, + "type" : "object" }, - { - "enum": [ - false - ], - "type": "boolean" + "description" : { + "maxLength" : 10000, + "type" : "string" }, - { - "enum": [ - "inherit" - ], - "type": "string" + "summary" : { + "description" : "AI-generated summary of the dashboard content", + "maxLength" : 10000, + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" } - ] - }, - "drill_down": { - "$ref": "#/components/schemas/JsonNode" - }, - "enable_section_headers": { - "description": "Whether section headers are enabled for container widgets.", - "type": "boolean" - }, - "ignore_dashboard_filters": { - "description": "Deprecated. Use ignoredFilters instead.", - "items": { - "description": "Deprecated. Use ignoredFilters instead.", - "type": "string" - }, - "type": "array" - }, - "ignored_filters": { - "description": "A list of dashboard filters to be ignored for this widget (GAAC).", - "items": { - "description": "A list of dashboard filters to be ignored for this widget (GAAC).", - "type": "string" }, - "type": "array" - }, - "interactions": { - "description": "Widget interactions (GAAC).", - "items": { - "$ref": "#/components/schemas/JsonNode" - }, - "type": "array" - }, - "layout_direction": { - "description": "Layout direction for container widgets.", - "type": "string" - }, - "metric": { - "description": "Inline metric reference.", - "type": "string" - }, - "rows": { - "description": "Widget height in grid rows (GAAC).", - "format": "int32", - "type": "integer" - }, - "sections": { - "description": "Nested sections for layout widgets.", - "items": { - "$ref": "#/components/schemas/AacSection" - }, - "type": "array" - }, - "size": { - "$ref": "#/components/schemas/AacWidgetSize" - }, - "title": { - "oneOf": [ - { - "type": "string" - }, - { - "enum": [ - false - ], - "type": "boolean" - } - ] - }, - "type": { - "description": "Widget type.", - "example": "visualization", - "type": "string" - }, - "visualization": { - "description": "Visualization ID reference.", - "type": "string" - }, - "visualizations": { - "description": "Visualization switcher items.", - "items": { - "$ref": "#/components/schemas/AacWidget" - }, - "type": "array" - }, - "zoom_data": { - "description": "Enable zooming to the data for certain visualization types (GAAC).", - "type": "boolean" - } - }, - "required": [ - "visualization" - ], - "type": "object" - }, - "AacWidget": { - "description": "Widgets in the section.", - "oneOf": [ - { - "$ref": "#/components/schemas/AacVisualizationWidget" + "required" : [ "content" ], + "type" : "object" }, - { - "$ref": "#/components/schemas/AacRichTextWidget" - }, - { - "$ref": "#/components/schemas/AacVisualizationSwitcherWidget" - }, - { - "$ref": "#/components/schemas/AacContainerWidget" - } - ] - }, - "AacWidgetSize": { - "description": "Deprecated widget size (legacy AAC).", - "properties": { - "height": { - "description": "Height in grid rows.", - "format": "int32", - "type": "integer" - }, - "height_as_ratio": { - "description": "Height definition mode.", - "type": "boolean" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "width": { - "description": "Width in grid columns.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "AacWorkspaceDataFilter": { - "description": "Workspace data filters.", - "properties": { - "data_type": { - "description": "Data type of the column.", - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "type": "string" - }, - "filter_id": { - "description": "Filter identifier.", - "type": "string" - }, - "source_column": { - "description": "Source column name.", - "type": "string" - } - }, - "required": [ - "data_type", - "filter_id", - "source_column" - ], - "type": "object" - }, - "AbsoluteDateFilter": { - "description": "A datetime filter specifying exact from and to values.", - "properties": { - "absoluteDateFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" - }, - "from": { - "example": "2020-07-01 18:23", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", - "type": "string" - }, - "includeEmptyValues": { - "description": "If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).", - "type": "boolean" - }, - "localIdentifier": { - "type": "string" - }, - "to": { - "example": "2020-07-16 23:59", - "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", - "type": "string" - } - }, - "required": [ - "from", - "to", - "dataset" - ], - "type": "object" - } - }, - "required": [ - "absoluteDateFilter" - ], - "type": "object" - }, - "AbstractMeasureValueFilter": { - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/RangeMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/CompoundMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/RankingFilter" - } - ], - "type": "object" - }, - "AfmIdentifier": { - "description": "Reference to the attribute label to which the filter should be applied.", - "oneOf": [ - { - "$ref": "#/components/schemas/AfmObjectIdentifier" - }, - { - "$ref": "#/components/schemas/AfmLocalIdentifier" - } - ], - "type": "object" - }, - "AfmLocalIdentifier": { - "properties": { - "localIdentifier": { - "example": "sampleAutoGenerated0123_ID", - "pattern": "^[.a-zA-Z0-9_-]+$", - "type": "string" - } - }, - "required": [ - "localIdentifier" - ], - "type": "object" - }, - "AfmObjectIdentifier": { - "description": "ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.", - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "enum": [ - "analyticalDashboard", - "attribute", - "dashboardPlugin", - "dataset", - "fact", - "label", - "metric", - "prompt", - "visualizationObject", - "filterContext" - ], - "example": "fact", - "type": "string" - } - }, - "required": [ - "type", - "id" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AfmObjectIdentifierAttribute": { - "description": "Reference to the date attribute to use.", - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "enum": [ - "attribute" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AfmObjectIdentifierCore": { - "description": "Reference to the metric, fact or attribute object to use for the metric.", - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "enum": [ - "attribute", - "label", - "fact", - "metric" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AfmObjectIdentifierDataset": { - "description": "Reference to the date dataset to which the filter should be applied.", - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "enum": [ - "dataset" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AfmObjectIdentifierLabel": { - "properties": { - "identifier": { - "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "enum": [ - "label" - ], - "type": "string" - } - }, - "required": [ - "type", - "id" - ], - "type": "object" - } - }, - "required": [ - "identifier" - ], - "type": "object" - }, - "AlertAfm": { - "properties": { - "attributes": { - "description": "Attributes to be used in the computation.", - "items": { - "$ref": "#/components/schemas/AttributeItem" - }, - "maximum": 1, - "type": "array" - }, - "auxMeasures": { - "description": "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "type": "array" - }, - "filters": { - "description": "Various filter types to filter execution result. For anomaly detection, exactly one dataset is specified in the condition. The AFM may contain multiple date filters for different datasets, but only the date filter matching the dataset from the condition is used for anomaly detection.", - "items": { - "$ref": "#/components/schemas/FilterDefinition" - }, - "type": "array" - }, - "measures": { - "description": "Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other.", - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "maximum": 2, - "minimum": 1, - "type": "array" - } - }, - "required": [ - "filters", - "measures" - ], - "type": "object" - }, - "AlertCondition": { - "description": "Alert trigger condition.", - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonWrapper" - }, - { - "$ref": "#/components/schemas/RangeWrapper" - }, - { - "$ref": "#/components/schemas/RelativeWrapper" - }, - { - "$ref": "#/components/schemas/AnomalyDetectionWrapper" - } - ], - "type": "object" - }, - "AlertConditionOperand": { - "description": "Operand of the alert condition.", - "oneOf": [ - { - "$ref": "#/components/schemas/LocalIdentifier" - }, - { - "$ref": "#/components/schemas/Value" - } - ], - "type": "object" - }, - "AnomalyDetection": { - "properties": { - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" - }, - "granularity": { - "description": "Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).", - "enum": [ - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR" - ], - "type": "string" - }, - "measure": { - "$ref": "#/components/schemas/LocalIdentifier" - }, - "sensitivity": { - "description": "Sensitivity level for anomaly detection", - "enum": [ - "LOW", - "MEDIUM", - "HIGH" - ], - "type": "string" - } - }, - "required": [ - "dataset", - "granularity", - "measure", - "sensitivity" - ], - "type": "object" - }, - "AnomalyDetectionWrapper": { - "properties": { - "anomaly": { - "$ref": "#/components/schemas/AnomalyDetection" - } - }, - "required": [ - "anomaly" - ], - "type": "object" - }, - "ApiEntitlement": { - "properties": { - "expiry": { - "format": "date", - "type": "string" - }, - "name": { - "enum": [ - "CacheStrategy", - "Contract", - "CustomTheming", - "ExtraCache", - "Hipaa", - "PdfExports", - "UiLocalization", - "Tier", - "UserCount", - "ManagedIdpUserCount", - "UnlimitedUsers", - "UnlimitedWorkspaces", - "WhiteLabeling", - "WorkspaceCount", - "UserTelemetryDisabled", - "AutomationCount", - "UnlimitedAutomations", - "AutomationRecipientCount", - "UnlimitedAutomationRecipients", - "DailyScheduledActionCount", - "UnlimitedDailyScheduledActions", - "DailyAlertActionCount", - "UnlimitedDailyAlertActions", - "ScheduledActionMinimumRecurrenceMinutes", - "FederatedIdentityManagement", - "AuditLogging", - "ControlledFeatureRollout", - "AiLake" - ], - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "ArithmeticMeasure": { - "properties": { - "left": { - "$ref": "#/components/schemas/LocalIdentifier" - }, - "operator": { - "description": "Arithmetic operator.\nDIFFERENCE - m₁−m₂ - the difference between two metrics.\nCHANGE - (m₁−m₂)÷m₂ - the relative difference between two metrics.\n", - "enum": [ - "DIFFERENCE", - "CHANGE" - ], - "type": "string" - }, - "right": { - "$ref": "#/components/schemas/LocalIdentifier" - } - }, - "required": [ - "left", - "operator", - "right" - ], - "type": "object" - }, - "ArithmeticMeasureDefinition": { - "description": "Metric representing arithmetics between other metrics.", - "properties": { - "arithmeticMeasure": { - "properties": { - "measureIdentifiers": { - "description": "List of metrics to apply arithmetic operation by chosen operator.", - "items": { - "$ref": "#/components/schemas/AfmLocalIdentifier" - }, - "type": "array" - }, - "operator": { - "description": "Arithmetic operator describing operation between metrics.", - "enum": [ - "SUM", - "DIFFERENCE", - "MULTIPLICATION", - "RATIO", - "CHANGE" - ], - "example": "SUM", - "type": "string" - } - }, - "required": [ - "measureIdentifiers", - "operator" - ], - "type": "object" - } - }, - "required": [ - "arithmeticMeasure" - ], - "type": "object" - }, - "Array": { - "items": { - "type": "string" - }, - "type": "array" - }, - "AssigneeIdentifier": { - "description": "Identifier of a user or user-group.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "user", - "userGroup" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "AssigneeRule": { - "description": "Identifier of an assignee rule.", - "properties": { - "type": { - "enum": [ - "allWorkspaceUsers" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "AttributeElements": { - "oneOf": [ - { - "$ref": "#/components/schemas/AttributeElementsByRef" - }, - { - "$ref": "#/components/schemas/AttributeElementsByValue" - } - ], - "type": "object" - }, - "AttributeElementsByRef": { - "properties": { - "uris": { - "description": "List of attribute elements by reference", - "items": { - "nullable": true, - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "uris" - ], - "type": "object" - }, - "AttributeElementsByValue": { - "properties": { - "values": { - "description": "List of attribute elements by value", - "items": { - "nullable": true, - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "values" - ], - "type": "object" - }, - "AttributeFilter": { - "description": "Abstract filter definition type attributes", - "oneOf": [ - { - "$ref": "#/components/schemas/NegativeAttributeFilter" - }, - { - "$ref": "#/components/schemas/PositiveAttributeFilter" - } - ], - "type": "object" - }, - "AttributeFilterByDate": { - "properties": { - "filterLocalIdentifier": { - "type": "string" - }, - "isCommonDate": { - "type": "boolean" - } - }, - "required": [ - "filterLocalIdentifier", - "isCommonDate" - ], - "type": "object" - }, - "AttributeFilterElements": { - "description": "Filter on specific set of label values.", - "properties": { - "values": { - "description": "Set of label values.", - "example": [ - "value1", - "value2" - ], - "items": { - "nullable": true, - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "values" - ], - "type": "object" - }, - "AttributeFilterParent": { - "properties": { - "filterLocalIdentifier": { - "type": "string" - }, - "over": { - "$ref": "#/components/schemas/Over" - } - }, - "required": [ - "filterLocalIdentifier", - "over" - ], - "type": "object" - }, - "AttributeItem": { - "properties": { - "label": { - "$ref": "#/components/schemas/AfmObjectIdentifierLabel" - }, - "localIdentifier": { - "description": "Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.", - "example": "attribute_1", - "pattern": "^[.a-zA-Z0-9_-]+$", - "type": "string" - }, - "showAllValues": { - "default": false, - "description": "Indicates whether to show all values of given attribute even if the data bound to those values is not available.", - "type": "boolean" - } - }, - "required": [ - "label", - "localIdentifier" - ], - "type": "object" - }, - "AutomationAlert": { - "properties": { - "condition": { - "oneOf": [ - { - "$ref": "#/components/schemas/AnomalyDetectionWrapper" - }, - { - "$ref": "#/components/schemas/ComparisonWrapper" - }, - { - "$ref": "#/components/schemas/RangeWrapper" - }, - { - "$ref": "#/components/schemas/RelativeWrapper" - } - ] - }, - "execution": { - "$ref": "#/components/schemas/AlertAfm" - }, - "trigger": { - "default": "ALWAYS", - "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\n", - "enum": [ - "ALWAYS", - "ONCE" - ], - "type": "string" - } - }, - "required": [ - "condition", - "execution" - ], - "type": "object" - }, - "AutomationDashboardTabularExport": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/DashboardTabularExportRequestV2" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "AutomationExternalRecipient": { - "properties": { - "email": { - "description": "E-mail address to send notifications from.", - "format": "email", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "analyticalDashboard" ], + "example" : "analyticalDashboard", + "type" : "string" } }, - "required": [ - "email" - ], - "type": "object" + "required" : [ "attributes", "type" ], + "type" : "object" }, - "AutomationImageExport": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/ImageExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "AutomationMetadata": { - "additionalProperties": true, - "description": "Additional information for the automation.", - "maxLength": 250000, - "nullable": true, - "properties": { - "visibleFilters": { - "items": { - "$ref": "#/components/schemas/VisibleFilter" - }, - "type": "array" - }, - "widget": { - "type": "string" + "JsonApiAnalyticalDashboardPostOptionalIdDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalId" } }, - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "AutomationRawExport": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/RawExportAutomationRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "AutomationSchedule": { - "properties": { - "cron": { - "description": "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", - "example": "0 */30 9-17 ? * MON-FRI", - "maxLength": 255, - "type": "string" - }, - "cronDescription": { - "description": "Human-readable description of the cron expression.", - "readOnly": true, - "type": "string" - }, - "firstRun": { - "description": "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", - "example": "2025-01-01T12:00:00Z", - "format": "date-time", - "type": "string" - }, - "timezone": { - "description": "Timezone in which the schedule is defined.", - "example": "Europe/Prague", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "cron", - "timezone" - ], - "type": "object" - }, - "AutomationSlidesExport": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/SlidesExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "AutomationTabularExport": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/TabularExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "AutomationVisualExport": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/VisualExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "AvailableAssignees": { - "properties": { - "userGroups": { - "description": "List of user groups", - "items": { - "$ref": "#/components/schemas/UserGroupAssignee" - }, - "type": "array" - }, - "users": { - "description": "List of users", - "items": { - "$ref": "#/components/schemas/UserAssignee" - }, - "type": "array" - } - }, - "required": [ - "userGroups", - "users" - ], - "type": "object" - }, - "BoundedFilter": { - "description": "Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range.", - "properties": { - "from": { - "description": "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). If null, then start of the range is unbounded.", - "example": -6, - "format": "int32", - "nullable": true, - "type": "integer" - }, - "granularity": { - "description": "Date granularity specifying particular date attribute in given dimension.", - "enum": [ - "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", - "MINUTE_OF_HOUR", - "HOUR_OF_DAY", - "DAY_OF_WEEK", - "DAY_OF_MONTH", - "DAY_OF_QUARTER", - "DAY_OF_YEAR", - "WEEK_OF_YEAR", - "MONTH_OF_YEAR", - "QUARTER_OF_YEAR", - "FISCAL_MONTH", - "FISCAL_QUARTER", - "FISCAL_YEAR" - ], - "example": "DAY", - "type": "string" - }, - "to": { - "description": "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.", - "example": 0, - "format": "int32", - "nullable": true, - "type": "integer" - } - }, - "required": [ - "granularity" - ], - "type": "object" - }, - "ColumnOverride": { - "description": "Table column override.", - "properties": { - "labelTargetColumn": { - "description": "Specifies the attribute's column to which this label is associated.", - "example": "users", - "type": "string" - }, - "labelType": { - "description": "Label type for the target attribute.", - "enum": [ - "TEXT", - "HYPERLINK", - "GEO", - "GEO_LONGITUDE", - "GEO_LATITUDE", - "GEO_AREA", - "IMAGE" - ], - "example": "HYPERLINK", - "type": "string" - }, - "ldmTypeOverride": { - "description": "Logical Data Model type for the column.", - "enum": [ - "FACT", - "LABEL" - ], - "example": "FACT", - "type": "string" - }, - "name": { - "description": "Column name.", - "example": "column_name", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "Comparison": { - "properties": { - "left": { - "$ref": "#/components/schemas/LocalIdentifier" - }, - "operator": { - "enum": [ - "GREATER_THAN", - "GREATER_THAN_OR_EQUAL_TO", - "LESS_THAN", - "LESS_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO" - ], - "type": "string" - }, - "right": { - "$ref": "#/components/schemas/AlertConditionOperand" - } - }, - "required": [ - "left", - "operator", - "right" - ], - "type": "object" - }, - "ComparisonCondition": { - "description": "Condition that compares the metric value to a given constant value using a comparison operator.", - "properties": { - "comparison": { - "properties": { - "operator": { - "enum": [ - "GREATER_THAN", - "GREATER_THAN_OR_EQUAL_TO", - "LESS_THAN", - "LESS_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO" - ], - "example": "GREATER_THAN", - "type": "string" - }, - "value": { - "example": 100, - "type": "number" - } - }, - "required": [ - "operator", - "value" - ], - "type": "object" - } - }, - "required": [ - "comparison" - ], - "type": "object" - }, - "ComparisonMeasureValueFilter": { - "description": "Filter the result by comparing specified metric to given constant value, using given comparison operator.", - "properties": { - "comparisonMeasureValueFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "type": "array" - }, - "localIdentifier": { - "type": "string" - }, - "measure": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "operator": { - "enum": [ - "GREATER_THAN", - "GREATER_THAN_OR_EQUAL_TO", - "LESS_THAN", - "LESS_THAN_OR_EQUAL_TO", - "EQUAL_TO", - "NOT_EQUAL_TO" - ], - "example": "GREATER_THAN", - "type": "string" - }, - "treatNullValuesAs": { - "description": "A value that will be substituted for null values in the metric for the comparisons.", - "example": 0, - "type": "number" - }, - "value": { - "example": 1327, - "type": "number" - } - }, - "required": [ - "operator", - "value", - "measure" - ], - "type": "object" - } - }, - "required": [ - "comparisonMeasureValueFilter" - ], - "type": "object" - }, - "ComparisonWrapper": { - "properties": { - "comparison": { - "$ref": "#/components/schemas/Comparison" - } - }, - "required": [ - "comparison" - ], - "type": "object" - }, - "CompoundMeasureValueFilter": { - "description": "Filter the result by applying multiple comparison and/or range conditions combined with OR logic. If conditions list is empty, no filtering is applied (all rows are returned).", - "properties": { - "compoundMeasureValueFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "conditions": { - "description": "List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned.", - "items": { - "$ref": "#/components/schemas/MeasureValueCondition" - }, - "type": "array" - }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "type": "array" - }, - "localIdentifier": { - "type": "string" - }, - "measure": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "treatNullValuesAs": { - "description": "A value that will be substituted for null values in the metric for the comparisons.", - "example": 0, - "type": "number" - } - }, - "required": [ - "conditions", - "measure" - ], - "type": "object" - } + "JsonApiAnalyticalDashboardToManyLinkage" : { + "description" : "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardLinkage" }, - "required": [ - "compoundMeasureValueFilter" - ], - "type": "object" + "type" : "array" }, - "ContentSlideTemplate": { - "description": "Settings for content slide.", - "nullable": true, - "properties": { - "descriptionField": { - "example": "{{dashboardFilters}}", - "nullable": true, - "type": "string" - }, - "footer": { - "$ref": "#/components/schemas/RunningSection" + "JsonApiAnalyticalDashboardToOneLinkage" : { + "description" : "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardLinkage" + } ] + }, + "JsonApiApiTokenIn" : { + "description" : "JSON:API representation of apiToken entity.", + "properties" : { + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "header": { - "$ref": "#/components/schemas/RunningSection" + "type" : { + "description" : "Object type", + "enum" : [ "apiToken" ], + "example" : "apiToken", + "type" : "string" } }, - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "CoverSlideTemplate": { - "description": "Settings for cover slide.", - "nullable": true, - "properties": { - "backgroundImage": { - "default": true, - "description": "Show background image on the slide.", - "type": "boolean" - }, - "descriptionField": { - "example": "Exported at: {{exportedAt}}", - "nullable": true, - "type": "string" - }, - "footer": { - "$ref": "#/components/schemas/RunningSection" - }, - "header": { - "$ref": "#/components/schemas/RunningSection" + "JsonApiApiTokenInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiApiTokenIn" } }, - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "CustomLabel": { - "description": "Custom label object override.", - "properties": { - "title": { - "description": "Override value.", - "type": "string" + "JsonApiApiTokenOut" : { + "description" : "JSON:API representation of apiToken entity.", + "properties" : { + "attributes" : { + "properties" : { + "bearerToken" : { + "description" : "The value of the Bearer token. It is only returned when the API token is created.", + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "apiToken" ], + "example" : "apiToken", + "type" : "string" } }, - "required": [ - "title" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "CustomMetric": { - "description": "Custom metric object override.", - "properties": { - "format": { - "description": "Format override.", - "type": "string" + "JsonApiApiTokenOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiApiTokenOut" }, - "title": { - "description": "Metric title override.", - "type": "string" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "required": [ - "format", - "title" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "CustomOverride": { - "description": "Custom cell value overrides (IDs will be replaced with specified values).", - "properties": { - "labels": { - "additionalProperties": { - "$ref": "#/components/schemas/CustomLabel" + "JsonApiApiTokenOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiApiTokenOutWithLinks" }, - "description": "Map of CustomLabels with keys used as placeholders in document.", - "type": "object" + "type" : "array", + "uniqueItems" : true }, - "metrics": { - "additionalProperties": { - "$ref": "#/components/schemas/CustomMetric" - }, - "description": "Map of CustomMetrics with keys used as placeholders in document.", - "type": "object" + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } + }, + "type" : "object" } }, - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "DashboardAttributeFilter": { - "properties": { - "attributeFilter": { - "properties": { - "attributeElements": { - "$ref": "#/components/schemas/AttributeElements" - }, - "displayForm": { - "$ref": "#/components/schemas/IdentifierRef" - }, - "filterElementsBy": { - "items": { - "$ref": "#/components/schemas/AttributeFilterParent" - }, - "type": "array" + "JsonApiApiTokenOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiApiTokenOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiAttributeHierarchyIn" : { + "description" : "JSON:API representation of attributeHierarchy entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" }, - "filterElementsByDate": { - "items": { - "$ref": "#/components/schemas/AttributeFilterByDate" + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { + "attributes" : [ { + "identifier" : { + "id" : "country", + "type" : "attribute" + } + }, { + "identifier" : { + "id" : "city", + "type" : "attribute" + } + } ] }, - "type": "array" - }, - "localIdentifier": { - "type": "string" + "type" : "object" }, - "negativeSelection": { - "type": "boolean" + "description" : { + "maxLength" : 10000, + "type" : "string" }, - "selectionMode": { - "enum": [ - "single", - "multi" - ], - "type": "string" - }, - "title": { - "type": "string" - }, - "validateElementsBy": { - "items": { - "$ref": "#/components/schemas/IdentifierRef" + "tags" : { + "items" : { + "type" : "string" }, - "type": "array" + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "required": [ - "attributeElements", - "displayForm", - "negativeSelection" - ], - "type": "object" + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "attributeHierarchy" ], + "example" : "attributeHierarchy", + "type" : "string" } }, - "required": [ - "attributeFilter" - ], - "type": "object" - }, - "DashboardDateFilter": { - "properties": { - "dateFilter": { - "properties": { - "attribute": { - "$ref": "#/components/schemas/IdentifierRef" - }, - "boundedFilter": { - "$ref": "#/components/schemas/RelativeBoundedDateFilter" - }, - "dataSet": { - "$ref": "#/components/schemas/IdentifierRef" - }, - "from": { - "oneOf": [ - { - "type": "string" - }, - { - "format": "int32", - "type": "integer" - } - ] - }, - "granularity": { - "enum": [ - "ALL_TIME_GRANULARITY", - "GDC.time.year", - "GDC.time.week_us", - "GDC.time.week_in_year", - "GDC.time.week_in_quarter", - "GDC.time.week", - "GDC.time.euweek_in_year", - "GDC.time.euweek_in_quarter", - "GDC.time.quarter", - "GDC.time.quarter_in_year", - "GDC.time.month", - "GDC.time.month_in_quarter", - "GDC.time.month_in_year", - "GDC.time.day_in_year", - "GDC.time.day_in_quarter", - "GDC.time.day_in_month", - "GDC.time.day_in_week", - "GDC.time.day_in_euweek", - "GDC.time.date", - "GDC.time.hour", - "GDC.time.hour_in_day", - "GDC.time.minute", - "GDC.time.minute_in_hour", - "GDC.time.fiscal_month", - "GDC.time.fiscal_quarter", - "GDC.time.fiscal_year" - ], - "type": "string" - }, - "includeEmptyValues": { - "type": "boolean" - }, - "localIdentifier": { - "type": "string" - }, - "to": { - "oneOf": [ - { - "type": "string" - }, - { - "format": "int32", - "type": "integer" - } - ] - }, - "type": { - "enum": [ - "relative", - "absolute" - ], - "type": "string" - } - }, - "required": [ - "granularity", - "type" - ], - "type": "object" - } - }, - "required": [ - "dateFilter" - ], - "type": "object" - }, - "DashboardExportSettings": { - "description": "Additional settings.", - "properties": { - "exportInfo": { - "default": false, - "description": "If true, the export will contain the information about the export – exported date, dashboard filters, etc.", - "example": true, - "type": "boolean" - }, - "mergeHeaders": { - "default": false, - "description": "Merge equal headers in neighbouring cells. Used for [XLSX] format only.", - "example": true, - "type": "boolean" - }, - "pageOrientation": { - "default": "PORTRAIT", - "description": "Set page orientation. (PDF)", - "enum": [ - "PORTRAIT", - "LANDSCAPE" - ], - "type": "string" - }, - "pageSize": { - "default": "A4", - "description": "Set page size. (PDF)", - "enum": [ - "A3", - "A4", - "LETTER" - ], - "type": "string" - } - }, - "type": "object" - }, - "DashboardFilter": { - "oneOf": [ - { - "$ref": "#/components/schemas/DashboardAttributeFilter" - }, - { - "$ref": "#/components/schemas/DashboardDateFilter" - } - ], - "type": "object" - }, - "DashboardPermissions": { - "properties": { - "rules": { - "description": "List of rules", - "items": { - "$ref": "#/components/schemas/RulePermission" - }, - "type": "array" - }, - "userGroups": { - "description": "List of user groups", - "items": { - "$ref": "#/components/schemas/UserGroupPermission" - }, - "type": "array" - }, - "users": { - "description": "List of users", - "items": { - "$ref": "#/components/schemas/UserPermission" - }, - "type": "array" - } - }, - "required": [ - "rules", - "userGroups", - "users" - ], - "type": "object" - }, - "DashboardPermissionsAssignment": { - "description": "Desired levels of permissions for an assignee.", - "properties": { - "permissions": { - "items": { - "enum": [ - "EDIT", - "SHARE", - "VIEW" - ], - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "permissions" - ], - "type": "object" - }, - "DashboardSlidesTemplate": { - "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", - "nullable": true, - "properties": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], - "items": { - "enum": [ - "PDF", - "PPTX" - ], - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "contentSlide": { - "$ref": "#/components/schemas/ContentSlideTemplate" - }, - "coverSlide": { - "$ref": "#/components/schemas/CoverSlideTemplate" - }, - "introSlide": { - "$ref": "#/components/schemas/IntroSlideTemplate" - }, - "sectionSlide": { - "$ref": "#/components/schemas/SectionSlideTemplate" - } - }, - "required": [ - "appliedOn" - ], - "type": "object" - }, - "DashboardTabularExportRequestV2": { - "description": "Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId).", - "properties": { - "dashboardFiltersOverride": { - "description": "List of filters that will be used instead of the default dashboard filters.", - "items": { - "$ref": "#/components/schemas/DashboardFilter" - }, - "type": "array" - }, - "dashboardId": { - "description": "Dashboard identifier", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - "type": "string" - }, - "dashboardTabsFiltersOverrides": { - "additionalProperties": { - "items": { - "$ref": "#/components/schemas/DashboardFilter" - }, - "type": "array" - }, - "description": "Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.", - "type": "object" - }, - "fileName": { - "description": "Filename of downloaded file without extension.", - "example": "result", - "type": "string" - }, - "format": { - "description": "Requested tabular export type.", - "enum": [ - "XLSX", - "PDF" - ], - "example": "XLSX", - "type": "string" - }, - "settings": { - "$ref": "#/components/schemas/DashboardExportSettings" - }, - "widgetIds": { - "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", - "items": { - "type": "string" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "dashboardId", - "fileName", - "format" - ], - "type": "object" - }, - "DataSourcePermissionAssignment": { - "description": "Data source permission assignments", - "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" - }, - "permissions": { - "items": { - "enum": [ - "MANAGE", - "USE" - ], - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "assigneeIdentifier", - "permissions" - ], - "type": "object" - }, - "DataSourceTableIdentifier": { - "description": "An id of the table. Including ID of data source.", - "example": { - "dataSourceId": "my-postgres", - "id": "customers", - "type": "DATA_SOURCE" - }, - "properties": { - "dataSourceId": { - "description": "Data source ID.", - "example": "my-postgres", - "maxLength": 255, - "type": "string" - }, - "id": { - "description": "ID of table.", - "example": "customers", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "path": { - "description": "Path to table.", - "example": [ - "table_schema", - "table_name" - ], - "items": { - "example": "table_name", - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "type": { - "description": "Data source entity type.", - "enum": [ - "dataSource" - ], - "example": "dataSource", - "type": "string" - } - }, - "required": [ - "dataSourceId", - "id", - "type" - ], - "type": "object" - }, - "DatasetGrain": { - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "attribute", - "date" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "DatasetReferenceIdentifier": { - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "dataset" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "DatasetWorkspaceDataFilterIdentifier": { - "description": "Identifier of a workspace data filter.", - "properties": { - "id": { - "description": "Workspace Data Filters ID.", - "example": "country_id", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Filter type.", - "enum": [ - "workspaceDataFilter" - ], - "example": "workspaceDataFilter", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "DateFilter": { - "description": "Abstract filter definition type for dates.", - "oneOf": [ - { - "$ref": "#/components/schemas/AbsoluteDateFilter" - }, - { - "$ref": "#/components/schemas/RelativeDateFilter" - } - ], - "type": "object" - }, - "DateValue": { - "properties": { - "value": { - "type": "string" - } - }, - "required": [ - "value" - ], - "type": "object" - }, - "DeclarativeAggregatedFact": { - "description": "A dataset fact.", - "properties": { - "description": { - "description": "Fact description.", - "example": "A number of orders created by the customer - including all orders, even the non-delivered ones.", - "maxLength": 10000, - "type": "string" - }, - "id": { - "description": "Fact ID.", - "example": "fact.customer_order_count", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "isNullable": { - "description": "Flag indicating whether the associated source column allows null values.", - "example": false, - "type": "boolean" - }, - "nullValue": { - "description": "Value used in coalesce during joins instead of null.", - "example": "0", - "type": "string" - }, - "sourceColumn": { - "description": "A name of the source column in the table.", - "example": "customer_order_count", - "maxLength": 255, - "type": "string" - }, - "sourceColumnDataType": { - "description": "A type of the source column", - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "example": "NUMERIC", - "maxLength": 255, - "type": "string" - }, - "sourceFactReference": { - "$ref": "#/components/schemas/DeclarativeSourceFactReference" - }, - "tags": { - "description": "A list of tags.", - "example": [ - "Customers" - ], - "items": { - "description": "A list of tags.", - "example": "[\"Customers\"]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "id", - "sourceColumn", - "sourceFactReference" - ], - "type": "object" - }, - "DeclarativeAnalyticalDashboard": { - "properties": { - "content": { - "$ref": "#/components/schemas/JsonNode" - }, - "createdAt": { - "description": "Time of the entity creation.", - "example": "2023-07-20 12:30", - "nullable": true, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", - "type": "string" - }, - "createdBy": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "description": { - "description": "Analytical dashboard description.", - "example": "Period to period comparison of revenues in main sectors.", - "maxLength": 10000, - "type": "string" - }, - "id": { - "description": "Analytical dashboard ID.", - "example": "revenues-analysis", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "modifiedAt": { - "description": "Time of the last entity modification.", - "example": "2023-07-20 12:30", - "nullable": true, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", - "type": "string" - }, - "modifiedBy": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "permissions": { - "description": "A list of permissions.", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardPermissionForAssignee" - }, - { - "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardPermissionForAssigneeRule" - } - ] - }, - "type": "array" - }, - "summary": { - "description": "AI-generated summary of the dashboard content", - "maxLength": 10000, - "type": "string" - }, - "tags": { - "description": "A list of tags.", - "example": [ - "Revenues" - ], - "items": { - "description": "A list of tags.", - "example": "[\"Revenues\"]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Analytical dashboard title.", - "example": "Revenues analysis", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content", - "id", - "title" - ], - "type": "object" - }, - "DeclarativeAnalyticalDashboardExtension": { - "properties": { - "id": { - "description": "Analytical dashboard ID.", - "example": "revenues-analysis", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "permissions": { - "description": "A list of permissions.", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardPermissionForAssignee" - }, - { - "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardPermissionForAssigneeRule" - } - ] - }, - "type": "array" - } - }, - "required": [ - "id", - "permissions" - ], - "type": "object" - }, - "DeclarativeAnalyticalDashboardIdentifier": { - "description": "An analytical dashboard identifier.", - "properties": { - "id": { - "description": "Identifier of the analytical dashboard.", - "example": "dashboard123", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "A type.", - "enum": [ - "analyticalDashboard" - ], - "example": "analyticalDashboard", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "DeclarativeAnalyticalDashboardPermissionAssignment": { - "description": "Analytical dashboard permission.", - "properties": { - "name": { - "description": "Permission name.", - "enum": [ - "EDIT", - "SHARE", - "VIEW" - ], - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "DeclarativeAnalyticalDashboardPermissionForAssignee": { - "allOf": [ - { - "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardPermissionAssignment" - }, - { - "properties": { - "assignee": { - "$ref": "#/components/schemas/AssigneeIdentifier" - } - }, - "type": "object" - } - ], - "description": "Analytical dashboard permission for an assignee.", - "required": [ - "assignee", - "name" - ], - "type": "object" - }, - "DeclarativeAnalyticalDashboardPermissionForAssigneeRule": { - "allOf": [ - { - "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardPermissionAssignment" - }, - { - "properties": { - "assigneeRule": { - "$ref": "#/components/schemas/AssigneeRule" - } - }, - "type": "object" - } - ], - "description": "Analytical dashboard permission for a collection of assignees identified by a rule.", - "required": [ - "assigneeRule", - "name" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "DeclarativeAnalytics": { - "description": "Entities describing users' view on data.", - "properties": { - "analytics": { - "$ref": "#/components/schemas/DeclarativeAnalyticsLayer" - } - }, - "type": "object" - }, - "DeclarativeAnalyticsLayer": { - "properties": { - "analyticalDashboardExtensions": { - "description": "A list of dashboard permissions assigned to a related dashboard.", - "items": { - "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardExtension" - }, - "type": "array" - }, - "analyticalDashboards": { - "description": "A list of analytical dashboards available in the model.", - "items": { - "$ref": "#/components/schemas/DeclarativeAnalyticalDashboard" - }, - "type": "array" - }, - "attributeHierarchies": { - "description": "A list of attribute hierarchies.", - "items": { - "$ref": "#/components/schemas/DeclarativeAttributeHierarchy" - }, - "type": "array" - }, - "dashboardPlugins": { - "description": "A list of dashboard plugins available in the model.", - "items": { - "$ref": "#/components/schemas/DeclarativeDashboardPlugin" - }, - "type": "array" - }, - "exportDefinitions": { - "description": "A list of export definitions.", - "items": { - "$ref": "#/components/schemas/DeclarativeExportDefinition" - }, - "type": "array" - }, - "filterContexts": { - "description": "A list of filter contexts available in the model.", - "items": { - "$ref": "#/components/schemas/DeclarativeFilterContext" - }, - "type": "array" - }, - "memoryItems": { - "description": "A list of AI memory items available in the workspace.", - "items": { - "$ref": "#/components/schemas/DeclarativeMemoryItem" - }, - "type": "array" - }, - "metrics": { - "description": "A list of metrics available in the model.", - "items": { - "$ref": "#/components/schemas/DeclarativeMetric" - }, - "type": "array" - }, - "visualizationObjects": { - "description": "A list of visualization objects available in the model.", - "items": { - "$ref": "#/components/schemas/DeclarativeVisualizationObject" - }, - "type": "array" - } - }, - "type": "object" - }, - "DeclarativeAttribute": { - "description": "A dataset attribute.", - "properties": { - "defaultView": { - "$ref": "#/components/schemas/LabelIdentifier" - }, - "description": { - "description": "Attribute description.", - "example": "Customer name including first and last name.", - "maxLength": 10000, - "type": "string" - }, - "id": { - "description": "Attribute ID.", - "example": "attr.customers.customer_name", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "isHidden": { - "description": "If true, this attribute is hidden from AI search results.", - "example": false, - "type": "boolean" - }, - "isNullable": { - "description": "Flag indicating whether the associated source column allows null values.", - "example": false, - "type": "boolean" - }, - "labels": { - "description": "An array of attribute labels.", - "items": { - "$ref": "#/components/schemas/DeclarativeLabel" - }, - "type": "array" - }, - "locale": { - "description": "Default locale for primary label.", - "example": "en-US", - "type": "string" - }, - "nullValue": { - "description": "Value used in coalesce during joins instead of null.", - "example": "empty_value", - "type": "string" - }, - "sortColumn": { - "description": "Attribute sort column.", - "example": "customer_name", - "maxLength": 255, - "type": "string" - }, - "sortDirection": { - "description": "Attribute sort direction.", - "enum": [ - "ASC", - "DESC" - ], - "example": "\"ASC\" | \"DESC\"", - "type": "string" - }, - "sourceColumn": { - "description": "A name of the source column that is the primary label", - "example": "customer_name", - "maxLength": 255, - "type": "string" - }, - "sourceColumnDataType": { - "description": "A type of the source column", - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "example": "STRING", - "maxLength": 255, - "type": "string" - }, - "tags": { - "description": "A list of tags.", - "example": [ - "Customers" - ], - "items": { - "description": "A list of tags.", - "example": "[\"Customers\"]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Attribute title.", - "example": "Customer Name", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "id", - "labels", - "sourceColumn", - "title" - ], - "type": "object" - }, - "DeclarativeAttributeHierarchy": { - "properties": { - "content": { - "$ref": "#/components/schemas/JsonNode" - }, - "createdAt": { - "description": "Time of the entity creation.", - "example": "[\"2023-07-20 12:30\"]", - "nullable": true, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", - "type": "string" - }, - "createdBy": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "description": { - "description": "Attribute hierarchy object description.", - "example": "Simple number for total goods in current production.", - "maxLength": 10000, - "type": "string" - }, - "id": { - "description": "Attribute hierarchy object ID.", - "example": "hierarchy-1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "modifiedAt": { - "description": "Time of the last entity modification.", - "example": "[\"2023-07-20 12:30\"]", - "nullable": true, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", - "type": "string" - }, - "modifiedBy": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "tags": { - "description": "A list of tags.", - "example": [ - "Revenues" - ], - "items": { - "description": "A list of tags.", - "example": "[\"Revenues\"]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Attribute hierarchy object title.", - "example": "Count of goods", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content", - "id", - "title" - ], - "type": "object" - }, - "DeclarativeAutomation": { - "properties": { - "alert": { - "$ref": "#/components/schemas/AutomationAlert" - }, - "analyticalDashboard": { - "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardIdentifier" - }, - "createdAt": { - "description": "Time of the entity creation.", - "example": "2023-07-20 12:30", - "nullable": true, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", - "type": "string" - }, - "createdBy": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "dashboardTabularExports": { - "items": { - "$ref": "#/components/schemas/AutomationDashboardTabularExport" - }, - "type": "array", - "uniqueItems": true - }, - "description": { - "maxLength": 255, - "type": "string" - }, - "details": { - "additionalProperties": { - "description": "TODO", - "maxLength": 10000, - "type": "string" - }, - "description": "TODO", - "maxLength": 10000, - "type": "object" - }, - "evaluationMode": { - "default": "PER_RECIPIENT", - "description": "Specify automation evaluation mode.", - "enum": [ - "SHARED", - "PER_RECIPIENT" - ], - "type": "string" - }, - "exportDefinitions": { - "items": { - "$ref": "#/components/schemas/DeclarativeExportDefinitionIdentifier" - }, - "type": "array", - "uniqueItems": true - }, - "externalRecipients": { - "description": "External recipients of the automation action results.", - "items": { - "$ref": "#/components/schemas/AutomationExternalRecipient" - }, - "type": "array", - "uniqueItems": true - }, - "id": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "imageExports": { - "items": { - "$ref": "#/components/schemas/AutomationImageExport" - }, - "type": "array", - "uniqueItems": true - }, - "metadata": { - "$ref": "#/components/schemas/AutomationMetadata" - }, - "modifiedAt": { - "description": "Time of the last entity modification.", - "example": "2023-07-20 12:30", - "nullable": true, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", - "type": "string" - }, - "modifiedBy": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "notificationChannel": { - "$ref": "#/components/schemas/DeclarativeNotificationChannelIdentifier" - }, - "rawExports": { - "items": { - "$ref": "#/components/schemas/AutomationRawExport" - }, - "type": "array", - "uniqueItems": true - }, - "recipients": { - "items": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "type": "array", - "uniqueItems": true - }, - "schedule": { - "$ref": "#/components/schemas/AutomationSchedule" - }, - "slidesExports": { - "items": { - "$ref": "#/components/schemas/AutomationSlidesExport" - }, - "type": "array", - "uniqueItems": true - }, - "state": { - "default": "ACTIVE", - "description": "Current state of the automation.", - "enum": [ - "ACTIVE", - "PAUSED" - ], - "type": "string" - }, - "tabularExports": { - "items": { - "$ref": "#/components/schemas/AutomationTabularExport" - }, - "type": "array", - "uniqueItems": true - }, - "tags": { - "items": { - "description": "A list of tags.", - "example": "[\"Revenue\",\"Sales\"]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "maxLength": 255, - "type": "string" - }, - "visualExports": { - "items": { - "$ref": "#/components/schemas/AutomationVisualExport" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "DeclarativeColorPalette": { - "description": "Color palette and its properties.", - "properties": { - "content": { - "$ref": "#/components/schemas/JsonNode" - }, - "id": { - "type": "string" - }, - "name": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content", - "id", - "name" - ], - "type": "object" - }, - "DeclarativeColumn": { - "description": "A table column.", - "properties": { - "dataType": { - "description": "Column type", - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "example": "INT", - "type": "string" - }, - "description": { - "description": "Column description/comment from database", - "example": "Customer unique identifier", - "maxLength": 10000, - "type": "string" - }, - "isNullable": { - "description": "Column is nullable", - "type": "boolean" - }, - "isPrimaryKey": { - "description": "Is column part of primary key?", - "type": "boolean" - }, - "name": { - "description": "Column name", - "example": "customer_id", - "maxLength": 255, - "pattern": "^[^\u0000]*$", - "type": "string" - }, - "referencedTableColumn": { - "description": "Referenced table (Foreign key)", - "example": "customer_id", - "maxLength": 255, - "type": "string" - }, - "referencedTableId": { - "description": "Referenced table (Foreign key)", - "example": "customers", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "dataType", - "name" - ], - "type": "object" - }, - "DeclarativeCspDirective": { - "properties": { - "directive": { - "maxLength": 255, - "type": "string" - }, - "sources": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "directive", - "sources" - ], - "type": "object" - }, - "DeclarativeCustomApplicationSetting": { - "description": "Custom application setting and its value.", - "properties": { - "applicationName": { - "description": "The application id", - "example": "Modeler", - "maxLength": 255, - "type": "string" - }, - "content": { - "$ref": "#/components/schemas/JsonNode" - }, - "id": { - "description": "Custom Application Setting ID.", - "example": "modeler.demo", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - "required": [ - "applicationName", - "content", - "id" - ], - "type": "object" - }, - "DeclarativeCustomGeoCollection": { - "description": "A declarative form of custom geo collection.", - "properties": { - "id": { - "description": "Custom geo collection ID.", - "example": "my-geo-collection", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "DeclarativeCustomGeoCollections": { - "description": "Custom geo collections.", - "properties": { - "customGeoCollections": { - "items": { - "$ref": "#/components/schemas/DeclarativeCustomGeoCollection" - }, - "type": "array" - } - }, - "required": [ - "customGeoCollections" - ], - "type": "object" - }, - "DeclarativeDashboardPlugin": { - "properties": { - "content": { - "$ref": "#/components/schemas/JsonNode" - }, - "createdAt": { - "description": "Time of the entity creation.", - "example": "[\"2023-07-20 12:30\"]", - "nullable": true, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", - "type": "string" - }, - "createdBy": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "description": { - "description": "Dashboard plugin description.", - "example": "Three dimensional view of data.", - "maxLength": 10000, - "type": "string" - }, - "id": { - "description": "Dashboard plugin object ID.", - "example": "dashboard-plugin-1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "modifiedAt": { - "description": "Time of the last entity modification.", - "example": "[\"2023-07-20 12:30\"]", - "nullable": true, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", - "type": "string" - }, - "modifiedBy": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "tags": { - "description": "A list of tags.", - "example": [ - "Revenues" - ], - "items": { - "description": "A list of tags.", - "example": "[\"Revenues\"]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Dashboard plugin object title.", - "example": "3D map renderer", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content", - "id", - "title" - ], - "type": "object" - }, - "DeclarativeDataSource": { - "description": "A data source and its properties.", - "properties": { - "alternativeDataSourceId": { - "description": "Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.", - "example": "pg_local_docker-demo2", - "nullable": true, - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "authenticationType": { - "description": "Type of authentication used to connect to the database.", - "enum": [ - "USERNAME_PASSWORD", - "TOKEN", - "KEY_PAIR", - "CLIENT_SECRET", - "ACCESS_TOKEN" - ], - "nullable": true, - "type": "string" - }, - "cacheStrategy": { - "description": "Determines how the results coming from a particular datasource should be cached.\n- ALWAYS: The results from the datasource should be cached normally (the default).\n- NEVER: The results from the datasource should never be cached.", - "enum": [ - "ALWAYS", - "NEVER" - ], - "type": "string" - }, - "clientId": { - "description": "Id of client with permission to connect to the data source.", - "example": "client1234", - "maxLength": 255, - "type": "string" - }, - "clientSecret": { - "description": "The client secret to use to connect to the database providing the data for the data source.", - "maxLength": 255, - "type": "string" - }, - "decodedParameters": { - "items": { - "$ref": "#/components/schemas/Parameter" - }, - "type": "array" - }, - "id": { - "description": "Data source ID.", - "example": "pg_local_docker-demo", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "name": { - "description": "Name of the data source.", - "example": "postgres demo", - "maxLength": 255, - "type": "string" - }, - "parameters": { - "items": { - "$ref": "#/components/schemas/Parameter" - }, - "type": "array" - }, - "password": { - "description": "Password for the data-source user, property is never returned back.", - "example": "*****", - "maxLength": 255, - "type": "string" - }, - "permissions": { - "items": { - "$ref": "#/components/schemas/DeclarativeDataSourcePermission" - }, - "type": "array" - }, - "privateKey": { - "description": "The private key to use to connect to the database providing the data for the data source.", - "maxLength": 15000, - "nullable": true, - "type": "string" - }, - "privateKeyPassphrase": { - "description": "The passphrase used to encrypt the private key.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "schema": { - "description": "A scheme/database with the data.", - "example": "demo", - "maxLength": 255, - "type": "string" - }, - "token": { - "description": "Token as an alternative to username and password.", - "example": "Bigquery service account JSON. Encode it using base64!", - "maxLength": 10000, - "type": "string" - }, - "type": { - "description": "Type of database.", - "enum": [ - "POSTGRESQL", - "REDSHIFT", - "VERTICA", - "SNOWFLAKE", - "ADS", - "BIGQUERY", - "MSSQL", - "PRESTO", - "DREMIO", - "DRILL", - "GREENPLUM", - "AZURESQL", - "SYNAPSESQL", - "DATABRICKS", - "GDSTORAGE", - "CLICKHOUSE", - "MYSQL", - "MARIADB", - "ORACLE", - "PINOT", - "SINGLESTORE", - "MOTHERDUCK", - "FLEXCONNECT", - "STARROCKS", - "ATHENA", - "MONGODB", - "CRATEDB" - ], - "example": "POSTGRESQL", - "type": "string" - }, - "url": { - "description": "An connection string relevant to type of database.", - "example": "jdbc:postgresql://postgres:5432/gooddata", - "maxLength": 255, - "type": "string" - }, - "username": { - "description": "User with permission connect the data source/database.", - "example": "demo", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "id", - "name", - "schema", - "type" - ], - "type": "object" - }, - "DeclarativeDataSourcePermission": { - "properties": { - "assignee": { - "$ref": "#/components/schemas/AssigneeIdentifier" - }, - "name": { - "description": "Permission name.", - "enum": [ - "MANAGE", - "USE" - ], - "type": "string" - } - }, - "required": [ - "assignee", - "name" - ], - "type": "object" - }, - "DeclarativeDataSourcePermissions": { - "description": "Data source permissions.", - "properties": { - "permissions": { - "items": { - "$ref": "#/components/schemas/DeclarativeDataSourcePermission" - }, - "type": "array" - } - }, - "type": "object" - }, - "DeclarativeDataSources": { - "description": "A data source and its properties.", - "properties": { - "dataSources": { - "items": { - "$ref": "#/components/schemas/DeclarativeDataSource" - }, - "type": "array" - } - }, - "required": [ - "dataSources" - ], - "type": "object" - }, - "DeclarativeDataset": { - "description": "A dataset defined by its properties.", - "properties": { - "aggregatedFacts": { - "description": "An array of aggregated facts.", - "items": { - "$ref": "#/components/schemas/DeclarativeAggregatedFact" - }, - "type": "array" - }, - "attributes": { - "description": "An array of attributes.", - "items": { - "$ref": "#/components/schemas/DeclarativeAttribute" - }, - "type": "array" - }, - "dataSourceTableId": { - "$ref": "#/components/schemas/DataSourceTableIdentifier" - }, - "description": { - "description": "A dataset description.", - "example": "The customers of ours.", - "maxLength": 10000, - "type": "string" - }, - "facts": { - "description": "An array of facts.", - "items": { - "$ref": "#/components/schemas/DeclarativeFact" - }, - "type": "array" - }, - "grain": { - "description": "An array of grain identifiers.", - "items": { - "$ref": "#/components/schemas/GrainIdentifier" - }, - "type": "array" - }, - "id": { - "description": "The Dataset ID. This ID is further used to refer to this instance of dataset.", - "example": "customers", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "precedence": { - "description": "Precedence used in aggregate awareness.", - "example": 0, - "format": "int32", - "minimum": 0, - "type": "integer" - }, - "references": { - "description": "An array of references.", - "items": { - "$ref": "#/components/schemas/DeclarativeReference" - }, - "type": "array" - }, - "sql": { - "$ref": "#/components/schemas/DeclarativeDatasetSql" - }, - "tags": { - "description": "A list of tags.", - "example": [ - "Customers" - ], - "items": { - "description": "A list of tags.", - "example": "[\"Customers\"]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "A dataset title.", - "example": "Customers", - "maxLength": 255, - "type": "string" - }, - "workspaceDataFilterColumns": { - "description": "An array of columns which are available for match to implicit workspace data filters.", - "items": { - "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilterColumn" - }, - "type": "array" - }, - "workspaceDataFilterReferences": { - "description": "An array of explicit workspace data filters.", - "items": { - "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilterReferences" - }, - "type": "array" - } - }, - "required": [ - "grain", - "id", - "references", - "title" - ], - "type": "object" - }, - "DeclarativeDatasetExtension": { - "description": "A dataset extension properties.", - "properties": { - "id": { - "description": "The Dataset ID. This ID is further used to refer to this instance of dataset.", - "example": "customers", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "workspaceDataFilterReferences": { - "description": "An array of explicit workspace data filters.", - "items": { - "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilterReferences" - }, - "type": "array" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "DeclarativeDatasetSql": { - "description": "SQL defining this dataset.", - "example": { - "dataSourceId": "my-postgres", - "statement": "SELECT * FROM some_table" - }, - "properties": { - "dataSourceId": { - "description": "Data source ID.", - "example": "my-postgres", - "type": "string" - }, - "statement": { - "description": "SQL statement.", - "example": "SELECT * FROM some_table", - "type": "string" - } - }, - "required": [ - "dataSourceId", - "statement" - ], - "type": "object" - }, - "DeclarativeDateDataset": { - "description": "A date dataset.", - "properties": { - "description": { - "description": "Date dataset description.", - "example": "A customer order date", - "maxLength": 10000, - "type": "string" - }, - "granularities": { - "description": "An array of date granularities. All listed granularities will be available for date dataset.", - "items": { - "enum": [ - "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", - "MINUTE_OF_HOUR", - "HOUR_OF_DAY", - "DAY_OF_WEEK", - "DAY_OF_MONTH", - "DAY_OF_QUARTER", - "DAY_OF_YEAR", - "WEEK_OF_YEAR", - "MONTH_OF_YEAR", - "QUARTER_OF_YEAR", - "FISCAL_MONTH", - "FISCAL_QUARTER", - "FISCAL_YEAR" - ], - "type": "string" - }, - "type": "array" - }, - "granularitiesFormatting": { - "$ref": "#/components/schemas/GranularitiesFormatting" - }, - "id": { - "description": "Date dataset ID.", - "example": "date", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "tags": { - "description": "A list of tags.", - "example": [ - "Customer dates" - ], - "items": { - "description": "A list of tags.", - "example": "[\"Customer dates\"]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Date dataset title.", - "example": "Date", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "granularities", - "granularitiesFormatting", - "id", - "title" - ], - "type": "object" - }, - "DeclarativeExportDefinition": { - "properties": { - "createdAt": { - "description": "Time of the entity creation.", - "example": "[\"2023-07-20 12:30\"]", - "nullable": true, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", - "type": "string" - }, - "createdBy": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "description": { - "description": "Export definition object description.", - "example": "Simple number for total goods in current production.", - "maxLength": 10000, - "type": "string" - }, - "id": { - "description": "Export definition id.", - "example": "export-definition-1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "modifiedAt": { - "description": "Time of the last entity modification.", - "example": "[\"2023-07-20 12:30\"]", - "nullable": true, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", - "type": "string" - }, - "modifiedBy": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "requestPayload": { - "oneOf": [ - { - "$ref": "#/components/schemas/TabularExportRequest" - }, - { - "$ref": "#/components/schemas/VisualExportRequest" - } - ] - }, - "tags": { - "description": "A list of tags.", - "example": [ - "Revenues" - ], - "items": { - "description": "A list of tags.", - "example": "[\"Revenues\"]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Export definition object title.", - "example": "My regular export", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "id", - "title" - ], - "type": "object" - }, - "DeclarativeExportDefinitionIdentifier": { - "description": "An export definition identifier.", - "properties": { - "id": { - "description": "Export definition identifier.", - "example": "export123", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "A type.", - "enum": [ - "exportDefinition" - ], - "example": "exportDefinition", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "DeclarativeExportTemplate": { - "description": "A declarative form of a particular export template.", - "properties": { - "dashboardSlidesTemplate": { - "$ref": "#/components/schemas/DashboardSlidesTemplate" - }, - "id": { - "description": "Identifier of an export template", - "example": "default-export-template", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "name": { - "description": "Name of an export template.", - "example": "My default export template", - "maxLength": 255, - "type": "string" - }, - "widgetSlidesTemplate": { - "$ref": "#/components/schemas/WidgetSlidesTemplate" - } - }, - "required": [ - "id", - "name" - ], - "type": "object" - }, - "DeclarativeExportTemplates": { - "description": "Export templates.", - "properties": { - "exportTemplates": { - "items": { - "$ref": "#/components/schemas/DeclarativeExportTemplate" - }, - "type": "array" - } - }, - "required": [ - "exportTemplates" - ], - "type": "object" - }, - "DeclarativeFact": { - "description": "A dataset fact.", - "properties": { - "description": { - "description": "Fact description.", - "example": "A number of orders created by the customer - including all orders, even the non-delivered ones.", - "maxLength": 10000, - "type": "string" - }, - "id": { - "description": "Fact ID.", - "example": "fact.customer_order_count", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "isHidden": { - "description": "If true, this fact is hidden from AI search results.", - "example": false, - "type": "boolean" - }, - "isNullable": { - "description": "Flag indicating whether the associated source column allows null values.", - "example": false, - "type": "boolean" - }, - "nullValue": { - "description": "Value used in coalesce during joins instead of null.", - "example": "0", - "type": "string" - }, - "sourceColumn": { - "description": "A name of the source column in the table.", - "example": "customer_order_count", - "maxLength": 255, - "type": "string" - }, - "sourceColumnDataType": { - "description": "A type of the source column", - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "example": "NUMERIC", - "maxLength": 255, - "type": "string" - }, - "tags": { - "description": "A list of tags.", - "example": [ - "Customers" - ], - "items": { - "description": "A list of tags.", - "example": "[\"Customers\"]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Fact title.", - "example": "Customer order count", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "id", - "sourceColumn", - "title" - ], - "type": "object" - }, - "DeclarativeFilterContext": { - "properties": { - "content": { - "$ref": "#/components/schemas/JsonNode" - }, - "description": { - "description": "Filter Context description.", - "example": "Filter Context for Sales team.", - "maxLength": 10000, - "type": "string" - }, - "id": { - "description": "Filter Context ID.", - "example": "filter-sales", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "tags": { - "description": "A list of tags.", - "example": [ - "Revenues" - ], - "items": { - "description": "A list of tags.", - "example": "[\"Revenues\"]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Filter Context title.", - "example": "Filter Context for Sales team", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content", - "id", - "title" - ], - "type": "object" - }, - "DeclarativeFilterView": { - "properties": { - "analyticalDashboard": { - "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardIdentifier" - }, - "content": { - "$ref": "#/components/schemas/JsonNode" - }, - "description": { - "maxLength": 255, - "type": "string" - }, - "id": { - "description": "FilterView object ID.", - "example": "filterView-1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "isDefault": { - "description": "Indicator whether the filter view should by applied by default.", - "type": "boolean" - }, - "tags": { - "items": { - "description": "A list of tags.", - "example": "[\"Revenue\",\"Sales\"]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "maxLength": 255, - "type": "string" - }, - "user": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - } - }, - "required": [ - "id", - "title" - ], - "type": "object" - }, - "DeclarativeIdentityProvider": { - "description": "Notification channels.", - "properties": { - "customClaimMapping": { - "additionalProperties": { - "type": "string" - }, - "description": "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name, urn.gooddata.user_groups [optional]). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", - "maxLength": 10000, - "type": "object" - }, - "id": { - "description": "FilterView object ID.", - "example": "filterView-1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "identifiers": { - "description": "List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.", - "example": [ - "gooddata.com" - ], - "items": { - "description": "List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.", - "example": "[\"gooddata.com\"]", - "type": "string" - }, - "type": "array" - }, - "idpType": { - "description": "Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", - "enum": [ - "MANAGED_IDP", - "FIM_IDP", - "DEX_IDP", - "CUSTOM_IDP" - ], - "type": "string" - }, - "oauthClientId": { - "description": "The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", - "maxLength": 255, - "type": "string" - }, - "oauthClientSecret": { - "description": "The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.", - "maxLength": 255, - "type": "string" - }, - "oauthCustomAuthAttributes": { - "additionalProperties": { - "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", - "maxLength": 10000, - "type": "string" - }, - "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", - "maxLength": 10000, - "type": "object" - }, - "oauthCustomScopes": { - "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", - "items": { - "maxLength": 255, - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "oauthIssuerId": { - "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", - "example": "myOidcProvider", - "maxLength": 255, - "type": "string" - }, - "oauthIssuerLocation": { - "description": "The location of your OIDC provider. This field is mandatory for OIDC IdP.", - "maxLength": 255, - "type": "string" - }, - "oauthSubjectIdClaim": { - "description": "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", - "example": "oid", - "maxLength": 255, - "type": "string" - }, - "samlMetadata": { - "description": "Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.", - "maxLength": 15000, - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "DeclarativeIdentityProviderIdentifier": { - "description": "An Identity Provider identifier.", - "properties": { - "id": { - "description": "Identifier of the identity provider.", - "example": "gooddata.com", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "A type.", - "enum": [ - "identityProvider" - ], - "example": "identityProvider", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "DeclarativeJwk": { - "description": "A declarative form of the JWK.", - "properties": { - "content": { - "$ref": "#/components/schemas/DeclarativeJwkSpecification" - }, - "id": { - "description": "JWK object ID.", - "example": "jwk-1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - "required": [ - "content", - "id" - ], - "type": "object" - }, - "DeclarativeJwkSpecification": { - "description": "Declarative specification of the cryptographic key.", - "oneOf": [ - { - "$ref": "#/components/schemas/DeclarativeRsaSpecification" - } - ], - "type": "object" - }, - "DeclarativeLabel": { - "description": "A attribute label.", - "properties": { - "description": { - "description": "Label description.", - "example": "Customer name", - "maxLength": 10000, - "type": "string" - }, - "geoAreaConfig": { - "$ref": "#/components/schemas/GeoAreaConfig" - }, - "id": { - "description": "Label ID.", - "example": "label.customer_name", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "isHidden": { - "description": "Determines if the label is hidden from AI features.", - "example": false, - "type": "boolean" - }, - "isNullable": { - "description": "Flag indicating whether the associated source column allows null values.", - "example": false, - "type": "boolean" - }, - "locale": { - "description": "Default label locale.", - "example": "en-US", - "type": "string" - }, - "nullValue": { - "description": "Value used in coalesce during joins instead of null.", - "example": "empty_value", - "type": "string" - }, - "sourceColumn": { - "description": "A name of the source column in the table.", - "example": "customer_name", - "maxLength": 255, - "type": "string" - }, - "sourceColumnDataType": { - "description": "A type of the source column", - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "example": "STRING", - "maxLength": 255, - "type": "string" - }, - "tags": { - "description": "A list of tags.", - "example": [ - "Customers" - ], - "items": { - "description": "A list of tags.", - "example": "[\"Customers\"]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Label title.", - "example": "Customer name", - "maxLength": 255, - "type": "string" - }, - "translations": { - "description": "Other translations.", - "items": { - "$ref": "#/components/schemas/DeclarativeLabelTranslation" - }, - "type": "array" - }, - "valueType": { - "description": "Specific type of label", - "enum": [ - "TEXT", - "HYPERLINK", - "GEO", - "GEO_LONGITUDE", - "GEO_LATITUDE", - "GEO_AREA", - "IMAGE" - ], - "type": "string" - } - }, - "required": [ - "id", - "sourceColumn", - "title" - ], - "type": "object" - }, - "DeclarativeLabelTranslation": { - "description": "A label translation.", - "properties": { - "locale": { - "description": "Translation locale.", - "example": "en-US", - "type": "string" - }, - "sourceColumn": { - "description": "Translation source column.", - "example": "customer_name_en", - "type": "string" - } - }, - "required": [ - "locale", - "sourceColumn" - ], - "type": "object" - }, - "DeclarativeLdm": { - "description": "A logical data model (LDM) representation.", - "properties": { - "datasetExtensions": { - "description": "An array containing extensions for datasets defined in parent workspaces.", - "items": { - "$ref": "#/components/schemas/DeclarativeDatasetExtension" - }, - "type": "array" - }, - "datasets": { - "description": "An array containing datasets.", - "items": { - "$ref": "#/components/schemas/DeclarativeDataset" - }, - "type": "array" - }, - "dateInstances": { - "description": "An array containing date-related datasets.", - "items": { - "$ref": "#/components/schemas/DeclarativeDateDataset" - }, - "type": "array" - } - }, - "type": "object" - }, - "DeclarativeMemoryItem": { - "properties": { - "createdAt": { - "description": "Time of the entity creation.", - "example": "2023-07-20 12:30", - "nullable": true, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", - "type": "string" - }, - "createdBy": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "description": { - "description": "Memory item description.", - "example": "Context about sales data for AI assistant.", - "maxLength": 10000, - "type": "string" - }, - "id": { - "description": "Memory item ID.", - "example": "sales-context", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "instruction": { - "description": "The text that will be injected into the system prompt.", - "example": "When discussing sales, always consider quarterly trends.", - "maxLength": 255, - "type": "string" - }, - "isDisabled": { - "description": "Whether memory item is disabled.", - "example": false, - "type": "boolean" - }, - "keywords": { - "description": "Set of unique strings used for semantic similarity filtering.", - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "modifiedAt": { - "description": "Time of the last entity modification.", - "example": "2023-07-20 12:30", - "nullable": true, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", - "type": "string" - }, - "modifiedBy": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "strategy": { - "description": "Strategy defining when the memory item should be applied", - "enum": [ - "ALWAYS", - "AUTO" - ], - "example": "AUTO", - "type": "string" - }, - "tags": { - "description": "A list of tags.", - "example": [ - "AI", - "Context" - ], - "items": { - "description": "A list of tags.", - "example": "[\"AI\",\"Context\"]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Memory item title.", - "example": "Sales Context", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "id", - "instruction", - "strategy", - "title" - ], - "type": "object" - }, - "DeclarativeMetric": { - "properties": { - "content": { - "$ref": "#/components/schemas/JsonNode" - }, - "createdAt": { - "description": "Time of the entity creation.", - "example": "[\"2023-07-20 12:30\"]", - "nullable": true, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", - "type": "string" - }, - "createdBy": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "description": { - "description": "Metric description.", - "example": "Sales for all the data available.", - "maxLength": 10000, - "type": "string" - }, - "id": { - "description": "Metric ID.", - "example": "total-sales", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "isHidden": { - "description": "If true, this metric is hidden from AI search results.", - "example": false, - "type": "boolean" - }, - "isHiddenFromKda": { - "description": "If true, this metric is hidden from key drive analysis.", - "example": false, - "type": "boolean" - }, - "modifiedAt": { - "description": "Time of the last entity modification.", - "example": "[\"2023-07-20 12:30\"]", - "nullable": true, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", - "type": "string" - }, - "modifiedBy": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "tags": { - "description": "A list of tags.", - "example": [ - "Revenues" - ], - "items": { - "description": "A list of tags.", - "example": "[\"Revenues\"]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Metric title.", - "example": "Total sales", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content", - "id", - "title" - ], - "type": "object" - }, - "DeclarativeModel": { - "description": "A data model structured as a set of its attributes.", - "properties": { - "ldm": { - "$ref": "#/components/schemas/DeclarativeLdm" - } - }, - "type": "object" - }, - "DeclarativeNotificationChannel": { - "description": "A declarative form of a particular notification channel.", - "properties": { - "allowedRecipients": { - "default": "INTERNAL", - "description": "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", - "enum": [ - "CREATOR", - "INTERNAL", - "EXTERNAL" - ], - "type": "string" - }, - "customDashboardUrl": { - "description": "Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are:\n{workspaceId}\n{dashboardId}\n{automationId}\n{asOfDate}\n", - "maxLength": 255, - "type": "string" - }, - "dashboardLinkVisibility": { - "default": "INTERNAL_ONLY", - "description": "Dashboard link visibility in notifications.\nHIDDEN - the link will not be included\nINTERNAL_ONLY - only internal users will see the link\nALL - all users will see the link\n", - "enum": [ - "HIDDEN", - "INTERNAL_ONLY", - "ALL" - ], - "type": "string" - }, - "description": { - "description": "Description of a notification channel.", - "example": "This is a channel", - "maxLength": 10000, - "type": "string" - }, - "destination": { - "oneOf": [ - { - "$ref": "#/components/schemas/DefaultSmtp" - }, - { - "$ref": "#/components/schemas/InPlatform" - }, - { - "$ref": "#/components/schemas/Smtp" - }, - { - "$ref": "#/components/schemas/Webhook" - } - ] - }, - "destinationType": { - "enum": [ - "WEBHOOK", - "SMTP", - "DEFAULT_SMTP", - "IN_PLATFORM" - ], - "nullable": true, - "readOnly": true, - "type": "string" - }, - "id": { - "description": "Identifier of a notification channel", - "example": "notification-channel-1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "inPlatformNotification": { - "default": "DISABLED", - "description": "In-platform notifications configuration. No effect if the destination type is IN_PLATFORM.\nDISABLED - in-platform notifications are not sent\nENABLED - in-platform notifications are sent in addition to the regular notifications\n", - "enum": [ - "DISABLED", - "ENABLED" - ], - "type": "string" - }, - "name": { - "description": "Name of a notification channel.", - "example": "channel", - "maxLength": 255, - "type": "string" - }, - "notificationSource": { - "description": "Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are:\n{{workspaceId}}\n{{workspaceName}}\n{{workspaceDescription}}\n{{dashboardId}}\n{{dashboardName}}\n{{dashboardDescription}}\n", - "maxLength": 10000, - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "DeclarativeNotificationChannelIdentifier": { - "description": "A notification channel identifier.", - "properties": { - "id": { - "description": "Notification channel identifier.", - "example": "webhook123", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "A type.", - "enum": [ - "notificationChannel" - ], - "example": "notificationChannel", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "DeclarativeNotificationChannels": { - "description": "Notification channels.", - "properties": { - "notificationChannels": { - "items": { - "$ref": "#/components/schemas/DeclarativeNotificationChannel" - }, - "type": "array" + "JsonApiAttributeHierarchyInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyIn" } }, - "required": [ - "notificationChannels" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "DeclarativeOrganization": { - "description": "Complete definition of an organization in a declarative form.", - "properties": { - "customGeoCollections": { - "items": { - "$ref": "#/components/schemas/DeclarativeCustomGeoCollection" - }, - "type": "array" - }, - "dataSources": { - "items": { - "$ref": "#/components/schemas/DeclarativeDataSource" - }, - "type": "array" - }, - "exportTemplates": { - "items": { - "$ref": "#/components/schemas/DeclarativeExportTemplate" - }, - "type": "array" - }, - "identityProviders": { - "items": { - "$ref": "#/components/schemas/DeclarativeIdentityProvider" - }, - "type": "array" - }, - "jwks": { - "items": { - "$ref": "#/components/schemas/DeclarativeJwk" - }, - "type": "array" - }, - "notificationChannels": { - "items": { - "$ref": "#/components/schemas/DeclarativeNotificationChannel" - }, - "type": "array" - }, - "organization": { - "$ref": "#/components/schemas/DeclarativeOrganizationInfo" - }, - "userGroups": { - "items": { - "$ref": "#/components/schemas/DeclarativeUserGroup" - }, - "type": "array" - }, - "users": { - "items": { - "$ref": "#/components/schemas/DeclarativeUser" - }, - "type": "array" - }, - "workspaceDataFilters": { - "items": { - "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilter" - }, - "type": "array" + "JsonApiAttributeHierarchyLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" }, - "workspaces": { - "items": { - "$ref": "#/components/schemas/DeclarativeWorkspace" - }, - "type": "array" + "type" : { + "enum" : [ "attributeHierarchy" ], + "type" : "string" } }, - "required": [ - "organization" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "DeclarativeOrganizationInfo": { - "description": "Information available about an organization.", - "properties": { - "allowedOrigins": { - "items": { - "type": "string" - }, - "type": "array" - }, - "colorPalettes": { - "description": "A list of color palettes.", - "items": { - "$ref": "#/components/schemas/DeclarativeColorPalette" - }, - "type": "array" - }, - "cspDirectives": { - "description": "A list of CSP directives.", - "items": { - "$ref": "#/components/schemas/DeclarativeCspDirective" - }, - "type": "array" - }, - "earlyAccess": { - "deprecated": true, - "description": "Early access defined on level Organization", - "maxLength": 255, - "type": "string" - }, - "earlyAccessValues": { - "description": "Early access defined on level Organization", - "items": { - "maxLength": 255, - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "hostname": { - "description": "Formal hostname used in deployment.", - "example": "alpha.com", - "maxLength": 255, - "type": "string" - }, - "id": { - "description": "Identifier of the organization.", - "example": "Alpha corporation", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "identityProvider": { - "$ref": "#/components/schemas/DeclarativeIdentityProviderIdentifier" - }, - "name": { - "description": "Formal name of the organization.", - "example": "Alpha corporation", - "maxLength": 255, - "type": "string" - }, - "permissions": { - "items": { - "$ref": "#/components/schemas/DeclarativeOrganizationPermission" - }, - "type": "array" - }, - "settings": { - "description": "A list of organization settings.", - "items": { - "$ref": "#/components/schemas/DeclarativeSetting" - }, - "type": "array" - }, - "themes": { - "description": "A list of themes.", - "items": { - "$ref": "#/components/schemas/DeclarativeTheme" - }, - "type": "array" - } - }, - "required": [ - "hostname", - "id", - "name", - "permissions" - ], - "type": "object" - }, - "DeclarativeOrganizationPermission": { - "description": "Definition of an organization permission assigned to a user/user-group.", - "properties": { - "assignee": { - "$ref": "#/components/schemas/AssigneeIdentifier" - }, - "name": { - "description": "Permission name.", - "enum": [ - "MANAGE", - "SELF_CREATE_TOKEN" - ], - "type": "string" - } - }, - "required": [ - "assignee", - "name" - ], - "type": "object" - }, - "DeclarativeReference": { - "description": "A dataset reference.", - "properties": { - "identifier": { - "$ref": "#/components/schemas/ReferenceIdentifier" - }, - "multivalue": { - "description": "The multi-value flag enables many-to-many cardinality for references.", - "example": false, - "type": "boolean" - }, - "sourceColumnDataTypes": { - "deprecated": true, - "description": "An array of source column data types for a given reference. Deprecated, use 'sources' instead.", - "items": { - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "type": "string" - }, - "type": "array" - }, - "sourceColumns": { - "deprecated": true, - "description": "An array of source column names for a given reference. Deprecated, use 'sources' instead.", - "example": [ - "customer_id" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "sources": { - "description": "An array of source columns for a given reference.", - "items": { - "$ref": "#/components/schemas/DeclarativeReferenceSource" - }, - "type": "array" - } - }, - "required": [ - "identifier", - "multivalue" - ], - "type": "object" - }, - "DeclarativeReferenceSource": { - "description": "A dataset reference source column description.", - "properties": { - "column": { - "description": "A name of the source column in the table.", - "example": "customer_id", - "maxLength": 255, - "type": "string" - }, - "dataType": { - "description": "A type of the source column.", - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "example": "STRING", - "maxLength": 255, - "type": "string" - }, - "isNullable": { - "description": "Flag indicating whether the associated source column allows null values.", - "example": false, - "type": "boolean" - }, - "nullValue": { - "description": "Value used in coalesce during joins instead of null.", - "example": "empty_value", - "type": "string" - }, - "target": { - "$ref": "#/components/schemas/GrainIdentifier" - } - }, - "required": [ - "column", - "target" - ], - "type": "object" - }, - "DeclarativeRsaSpecification": { - "description": "Declarative specification of the cryptographic key.", - "properties": { - "alg": { - "description": "Algorithm intended for use with the key.", - "enum": [ - "RS256", - "RS384", - "RS512" - ], - "example": "RS256", - "type": "string" - }, - "e": { - "description": "parameter contains the exponent value for the RSA public key.", - "type": "string" - }, - "kid": { - "description": "Parameter is used to match a specific key.", - "example": "key.001", - "maxLength": 255, - "pattern": "^[^.]", - "type": "string" - }, - "kty": { - "description": "Key type parameter", - "enum": [ - "RSA" - ], - "example": "RSA", - "type": "string" - }, - "n": { - "description": "Parameter contains the modulus value for the RSA public key.", - "type": "string" - }, - "use": { - "description": "Parameter identifies the intended use of the public key.", - "enum": [ - "sig" - ], - "example": "sig", - "type": "string" - }, - "x5c": { - "description": "Parameter contains a chain of one or more PKIX certificates.", - "items": { - "type": "string" - }, - "type": "array" - }, - "x5t": { - "description": "Parameter is a base64url-encoded SHA-1 thumbprint of the DER encoding of an X.509 certificate.", - "type": "string" - } - }, - "required": [ - "alg", - "e", - "kid", - "kty", - "n", - "use" - ], - "type": "object" - }, - "DeclarativeSetting": { - "description": "Setting and its value.", - "properties": { - "content": { - "$ref": "#/components/schemas/JsonNode" - }, - "id": { - "description": "Setting ID.", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Type of the setting.", - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_ENDPOINT", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "SORT_CASE_SENSITIVE", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS" - ], - "example": "TIMEZONE", - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "DeclarativeSingleWorkspacePermission": { - "properties": { - "assignee": { - "$ref": "#/components/schemas/AssigneeIdentifier" - }, - "name": { - "description": "Permission name.", - "enum": [ - "MANAGE", - "ANALYZE", - "EXPORT", - "EXPORT_TABULAR", - "EXPORT_PDF", - "CREATE_AUTOMATION", - "USE_AI_ASSISTANT", - "CREATE_FILTER_VIEW", - "VIEW" - ], - "type": "string" - } - }, - "required": [ - "assignee", - "name" - ], - "type": "object" - }, - "DeclarativeSourceFactReference": { - "description": "Aggregated awareness source fact reference.", - "properties": { - "operation": { - "description": "Aggregation operation.", - "enum": [ - "SUM", - "MIN", - "MAX" - ], - "example": "SUM", - "type": "string" - }, - "reference": { - "$ref": "#/components/schemas/FactIdentifier" - } - }, - "required": [ - "operation", - "reference" - ], - "type": "object" - }, - "DeclarativeTable": { - "description": "A database table.", - "properties": { - "columns": { - "description": "An array of physical columns", - "items": { - "$ref": "#/components/schemas/DeclarativeColumn" - }, - "type": "array" - }, - "id": { - "description": "Table id.", - "example": "customers", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "namePrefix": { - "description": "Table or view name prefix used in scan. Will be stripped when generating LDM.", - "example": "out_gooddata", - "maxLength": 255, - "type": "string" - }, - "path": { - "description": "Path to table.", - "example": [ - "table_schema", - "table_name" - ], - "items": { - "example": "table_name", - "type": "string" - }, - "type": "array" - }, - "type": { - "description": "Table type: TABLE or VIEW.", - "example": "TABLE", - "type": "string" - } - }, - "required": [ - "columns", - "id", - "path", - "type" - ], - "type": "object" - }, - "DeclarativeTheme": { - "description": "Theme and its properties.", - "properties": { - "content": { - "$ref": "#/components/schemas/JsonNode" - }, - "id": { - "type": "string" - }, - "name": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content", - "id", - "name" - ], - "type": "object" - }, - "DeclarativeUser": { - "description": "A user and its properties", - "properties": { - "authId": { - "description": "User identification in the authentication manager.", - "maxLength": 255, - "type": "string" - }, - "email": { - "description": "User email address", - "example": "user@example.com", - "maxLength": 255, - "type": "string" - }, - "firstname": { - "description": "User first name", - "example": "John", - "maxLength": 255, - "type": "string" - }, - "id": { - "description": "User identifier.", - "example": "employee123", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "lastname": { - "description": "User last name", - "example": "Wick", - "maxLength": 255, - "type": "string" - }, - "permissions": { - "items": { - "$ref": "#/components/schemas/DeclarativeUserPermission" - }, - "type": "array" - }, - "settings": { - "description": "A list of user settings.", - "items": { - "$ref": "#/components/schemas/DeclarativeSetting" - }, - "type": "array" - }, - "userGroups": { - "items": { - "$ref": "#/components/schemas/DeclarativeUserGroupIdentifier" - }, - "type": "array" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "DeclarativeUserDataFilter": { - "description": "User Data Filters serving the filtering of what data users can see in workspaces.", - "properties": { - "description": { - "description": "User Data Filters setting description.", - "example": "ID of country setting", - "maxLength": 10000, - "type": "string" - }, - "id": { - "description": "User Data Filters ID. This ID is further used to refer to this instance.", - "example": "country_id_setting", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "maql": { - "description": "Expression in MAQL specifying the User Data Filter", - "example": "{label/country} = \"USA\" AND {label/date.year} = THIS(YEAR)", - "maxLength": 10000, - "type": "string" - }, - "tags": { - "description": "A list of tags.", - "example": [ - "Revenues" - ], - "items": { - "description": "A list of tags.", - "example": "[\"Revenues\"]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "User Data Filters setting title.", - "example": "Country ID setting", - "maxLength": 255, - "type": "string" - }, - "user": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "userGroup": { - "$ref": "#/components/schemas/DeclarativeUserGroupIdentifier" - } - }, - "required": [ - "id", - "maql", - "title" - ], - "type": "object" - }, - "DeclarativeUserDataFilters": { - "description": "Declarative form of user data filters.", - "properties": { - "userDataFilters": { - "items": { - "$ref": "#/components/schemas/DeclarativeUserDataFilter" - }, - "type": "array" - } - }, - "required": [ - "userDataFilters" - ], - "type": "object" - }, - "DeclarativeUserGroup": { - "description": "A user-group and its properties", - "properties": { - "id": { - "description": "UserGroup identifier.", - "example": "employees.all", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "name": { - "description": "Name of UserGroup", - "example": "admins", - "maxLength": 255, - "type": "string" - }, - "parents": { - "items": { - "$ref": "#/components/schemas/DeclarativeUserGroupIdentifier" - }, - "type": "array" - }, - "permissions": { - "items": { - "$ref": "#/components/schemas/DeclarativeUserGroupPermission" - }, - "type": "array" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "DeclarativeUserGroupIdentifier": { - "description": "A user group identifier.", - "example": { - "id": "admins", - "type": "userGroup" - }, - "properties": { - "id": { - "description": "Identifier of the user group.", - "example": "group.admins", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "A type.", - "enum": [ - "userGroup" - ], - "example": "userGroup", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "DeclarativeUserGroupPermission": { - "description": "Definition of a user-group permission assigned to a user/user-group.", - "properties": { - "assignee": { - "$ref": "#/components/schemas/AssigneeIdentifier" - }, - "name": { - "description": "Permission name.", - "enum": [ - "SEE" - ], - "type": "string" - } - }, - "required": [ - "assignee", - "name" - ], - "type": "object" - }, - "DeclarativeUserGroupPermissions": { - "description": "Definition of permissions associated with a user-group.", - "properties": { - "permissions": { - "items": { - "$ref": "#/components/schemas/DeclarativeUserGroupPermission" - }, - "type": "array" - } - }, - "type": "object" - }, - "DeclarativeUserGroups": { - "description": "Declarative form of userGroups and its properties.", - "properties": { - "userGroups": { - "items": { - "$ref": "#/components/schemas/DeclarativeUserGroup" - }, - "type": "array" - } - }, - "required": [ - "userGroups" - ], - "type": "object" - }, - "DeclarativeUserIdentifier": { - "description": "A user identifier.", - "example": { - "id": "example123", - "type": "user" - }, - "properties": { - "id": { - "description": "User identifier.", - "example": "employee123", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "A type.", - "enum": [ - "user" - ], - "example": "user", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "DeclarativeUserPermission": { - "description": "Definition of a user permission assigned to a user/user-group.", - "properties": { - "assignee": { - "$ref": "#/components/schemas/AssigneeIdentifier" - }, - "name": { - "description": "Permission name.", - "enum": [ - "SEE" - ], - "type": "string" - } - }, - "required": [ - "assignee", - "name" - ], - "type": "object" - }, - "DeclarativeUserPermissions": { - "description": "Definition of permissions associated with a user.", - "properties": { - "permissions": { - "items": { - "$ref": "#/components/schemas/DeclarativeUserPermission" - }, - "type": "array" - } - }, - "type": "object" - }, - "DeclarativeUsers": { - "description": "Declarative form of users and its properties.", - "properties": { - "users": { - "items": { - "$ref": "#/components/schemas/DeclarativeUser" - }, - "type": "array" - } - }, - "required": [ - "users" - ], - "type": "object" - }, - "DeclarativeUsersUserGroups": { - "description": "Declarative form of both users and user groups and theirs properties.", - "properties": { - "userGroups": { - "items": { - "$ref": "#/components/schemas/DeclarativeUserGroup" - }, - "type": "array" - }, - "users": { - "items": { - "$ref": "#/components/schemas/DeclarativeUser" - }, - "type": "array" - } - }, - "required": [ - "userGroups", - "users" - ], - "type": "object" - }, - "DeclarativeVisualizationObject": { - "properties": { - "content": { - "$ref": "#/components/schemas/JsonNode" - }, - "createdAt": { - "description": "Time of the entity creation.", - "example": "[\"2023-07-20 12:30\"]", - "nullable": true, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", - "type": "string" - }, - "createdBy": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "description": { - "description": "Visualization object description.", - "example": "Simple number for total goods in current production.", - "maxLength": 10000, - "type": "string" - }, - "id": { - "description": "Visualization object ID.", - "example": "visualization-1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "isHidden": { - "description": "If true, this visualization object is hidden from AI search results.", - "example": false, - "type": "boolean" - }, - "modifiedAt": { - "description": "Time of the last entity modification.", - "example": "[\"2023-07-20 12:30\"]", - "nullable": true, - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", - "type": "string" - }, - "modifiedBy": { - "$ref": "#/components/schemas/DeclarativeUserIdentifier" - }, - "tags": { - "description": "A list of tags.", - "example": [ - "Revenues" - ], - "items": { - "description": "A list of tags.", - "example": "[\"Revenues\"]", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Visualization object title.", - "example": "Count of goods", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content", - "id", - "title" - ], - "type": "object" - }, - "DeclarativeWorkspace": { - "description": "A declarative form of a particular workspace.", - "properties": { - "automations": { - "items": { - "$ref": "#/components/schemas/DeclarativeAutomation" - }, - "type": "array" - }, - "cacheExtraLimit": { - "description": "Extra cache limit allocated to specific workspace. In case there is extra cache budget setup for organization, it can be split between multiple workspaces.", - "format": "int64", - "type": "integer" - }, - "customApplicationSettings": { - "description": "A list of workspace custom settings.", - "items": { - "$ref": "#/components/schemas/DeclarativeCustomApplicationSetting" - }, - "type": "array" - }, - "dataSource": { - "$ref": "#/components/schemas/WorkspaceDataSource" - }, - "description": { - "description": "Description of the workspace", - "maxLength": 255, - "type": "string" - }, - "earlyAccess": { - "deprecated": true, - "description": "Early access defined on level Workspace", - "maxLength": 255, - "type": "string" - }, - "earlyAccessValues": { - "description": "Early access defined on level Workspace", - "items": { - "maxLength": 255, - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "filterViews": { - "items": { - "$ref": "#/components/schemas/DeclarativeFilterView" - }, - "type": "array" - }, - "hierarchyPermissions": { - "items": { - "$ref": "#/components/schemas/DeclarativeWorkspaceHierarchyPermission" - }, - "type": "array" - }, - "id": { - "description": "Identifier of a workspace", - "example": "alpha.sales", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "model": { - "$ref": "#/components/schemas/DeclarativeWorkspaceModel" - }, - "name": { - "description": "Name of a workspace to view.", - "example": "Alpha Sales", - "maxLength": 255, - "type": "string" - }, - "parent": { - "$ref": "#/components/schemas/WorkspaceIdentifier" - }, - "permissions": { - "items": { - "$ref": "#/components/schemas/DeclarativeSingleWorkspacePermission" - }, - "type": "array" - }, - "prefix": { - "description": "Custom prefix of entity identifiers in workspace", - "maxLength": 255, - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "settings": { - "description": "A list of workspace settings.", - "items": { - "$ref": "#/components/schemas/DeclarativeSetting" - }, - "type": "array" - }, - "userDataFilters": { - "description": "A list of workspace user data filters.", - "items": { - "$ref": "#/components/schemas/DeclarativeUserDataFilter" - }, - "type": "array" - } - }, - "required": [ - "id", - "name" - ], - "type": "object" - }, - "DeclarativeWorkspaceDataFilter": { - "description": "Workspace Data Filters serving the filtering of what data users can see in workspaces.", - "properties": { - "columnName": { - "description": "Workspace Data Filters column name. Data are filtered using this physical column.", - "example": "country_id", - "maxLength": 255, - "type": "string" - }, - "description": { - "description": "Workspace Data Filters description.", - "example": "ID of country", - "maxLength": 10000, - "type": "string" - }, - "id": { - "description": "Workspace Data Filters ID. This ID is further used to refer to this instance.", - "example": "country_id", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "title": { - "description": "Workspace Data Filters title.", - "example": "Country ID", - "maxLength": 255, - "type": "string" - }, - "workspace": { - "$ref": "#/components/schemas/WorkspaceIdentifier" - }, - "workspaceDataFilterSettings": { - "description": "Filter settings specifying values of filters valid for the workspace.", - "items": { - "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilterSetting" - }, - "type": "array" - } - }, - "required": [ - "columnName", - "id", - "title", - "workspace", - "workspaceDataFilterSettings" - ], - "type": "object" - }, - "DeclarativeWorkspaceDataFilterColumn": { - "properties": { - "dataType": { - "description": "Data type of the column", - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "example": "INT", - "type": "string" - }, - "name": { - "description": "Name of the column", - "example": "customer_id", - "type": "string" - } - }, - "required": [ - "dataType", - "name" - ], - "type": "object" - }, - "DeclarativeWorkspaceDataFilterReferences": { - "properties": { - "filterColumn": { - "description": "Filter column name", - "example": "filter_id", - "type": "string" - }, - "filterColumnDataType": { - "description": "Filter column data type", - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "example": "INT", - "type": "string" - }, - "filterId": { - "$ref": "#/components/schemas/DatasetWorkspaceDataFilterIdentifier" - } - }, - "required": [ - "filterColumn", - "filterColumnDataType", - "filterId" - ], - "type": "object" - }, - "DeclarativeWorkspaceDataFilterSetting": { - "description": "Workspace Data Filters serving the filtering of what data users can see in workspaces.", - "properties": { - "description": { - "description": "Workspace Data Filters setting description.", - "example": "ID of country setting", - "maxLength": 10000, - "type": "string" - }, - "filterValues": { - "description": "Only those rows are returned, where columnName from filter matches those values.", - "example": [ - "US" - ], - "items": { - "description": "Only those rows are returned, where columnName from filter matches those values.", - "example": "[\"US\"]", - "type": "string" - }, - "type": "array" - }, - "id": { - "description": "Workspace Data Filters ID. This ID is further used to refer to this instance.", - "example": "country_id_setting", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "title": { - "description": "Workspace Data Filters setting title.", - "example": "Country ID setting", - "maxLength": 255, - "type": "string" - }, - "workspace": { - "$ref": "#/components/schemas/WorkspaceIdentifier" - } - }, - "required": [ - "filterValues", - "id", - "title", - "workspace" - ], - "type": "object" - }, - "DeclarativeWorkspaceDataFilters": { - "description": "Declarative form of data filters.", - "properties": { - "workspaceDataFilters": { - "items": { - "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilter" - }, - "type": "array" - } - }, - "required": [ - "workspaceDataFilters" - ], - "type": "object" - }, - "DeclarativeWorkspaceHierarchyPermission": { - "properties": { - "assignee": { - "$ref": "#/components/schemas/AssigneeIdentifier" - }, - "name": { - "description": "Permission name.", - "enum": [ - "MANAGE", - "ANALYZE", - "EXPORT", - "EXPORT_TABULAR", - "EXPORT_PDF", - "CREATE_AUTOMATION", - "USE_AI_ASSISTANT", - "CREATE_FILTER_VIEW", - "VIEW" - ], - "type": "string" - } - }, - "required": [ - "assignee", - "name" - ], - "type": "object" - }, - "DeclarativeWorkspaceModel": { - "description": "A declarative form of a model and analytics for a workspace.", - "properties": { - "analytics": { - "$ref": "#/components/schemas/DeclarativeAnalyticsLayer" - }, - "ldm": { - "$ref": "#/components/schemas/DeclarativeLdm" - } - }, - "type": "object" - }, - "DeclarativeWorkspacePermissions": { - "description": "Definition of permissions associated with a workspace.", - "properties": { - "hierarchyPermissions": { - "items": { - "$ref": "#/components/schemas/DeclarativeWorkspaceHierarchyPermission" - }, - "type": "array" - }, - "permissions": { - "items": { - "$ref": "#/components/schemas/DeclarativeSingleWorkspacePermission" - }, - "type": "array" - } - }, - "type": "object" - }, - "DeclarativeWorkspaces": { - "description": "A declarative form of a all workspace layout.", - "properties": { - "workspaceDataFilters": { - "items": { - "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilter" - }, - "type": "array" - }, - "workspaces": { - "items": { - "$ref": "#/components/schemas/DeclarativeWorkspace" - }, - "type": "array" - } - }, - "required": [ - "workspaceDataFilters", - "workspaces" - ], - "type": "object" - }, - "DefaultSmtp": { - "allOf": [ - { - "properties": { - "fromEmail": { - "default": "no-reply@gooddata.com", - "description": "E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.", - "format": "email", - "type": "string" - }, - "fromEmailName": { - "default": "GoodData", - "description": "An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.", - "type": "string" - }, - "type": { - "description": "The destination type.", - "enum": [ - "DEFAULT_SMTP" - ], - "type": "string" - } - }, - "type": "object" - } - ], - "description": "Default SMTP destination for notifications.", - "required": [ - "type" - ], - "type": "object" - }, - "DependentEntitiesGraph": { - "properties": { - "edges": { - "items": { - "items": { - "$ref": "#/components/schemas/EntityIdentifier" - }, - "type": "array" - }, - "type": "array", - "uniqueItems": true - }, - "nodes": { - "items": { - "$ref": "#/components/schemas/DependentEntitiesNode" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "edges", - "nodes" - ], - "type": "object" - }, - "DependentEntitiesNode": { - "properties": { - "id": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "enum": [ - "analyticalDashboard", - "attribute", - "attributeHierarchy", - "dashboardPlugin", - "dataset", - "fact", - "label", - "metric", - "userDataFilter", - "automation", - "memoryItem", - "knowledgeRecommendation", - "visualizationObject", - "filterContext", - "filterView" - ], - "example": "metric", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "DependentEntitiesRequest": { - "properties": { - "identifiers": { - "items": { - "$ref": "#/components/schemas/EntityIdentifier" - }, - "type": "array" - } - }, - "required": [ - "identifiers" - ], - "type": "object" - }, - "DependentEntitiesResponse": { - "properties": { - "graph": { - "$ref": "#/components/schemas/DependentEntitiesGraph" - } - }, - "required": [ - "graph" - ], - "type": "object" - }, - "EntitlementsRequest": { - "properties": { - "entitlementsName": { - "items": { - "enum": [ - "CacheStrategy", - "Contract", - "CustomTheming", - "ExtraCache", - "Hipaa", - "PdfExports", - "UiLocalization", - "Tier", - "UserCount", - "ManagedIdpUserCount", - "UnlimitedUsers", - "UnlimitedWorkspaces", - "WhiteLabeling", - "WorkspaceCount", - "UserTelemetryDisabled", - "AutomationCount", - "UnlimitedAutomations", - "AutomationRecipientCount", - "UnlimitedAutomationRecipients", - "DailyScheduledActionCount", - "UnlimitedDailyScheduledActions", - "DailyAlertActionCount", - "UnlimitedDailyAlertActions", - "ScheduledActionMinimumRecurrenceMinutes", - "FederatedIdentityManagement", - "AuditLogging", - "ControlledFeatureRollout", - "AiLake" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "entitlementsName" - ], - "type": "object" - }, - "EntityIdentifier": { - "properties": { - "id": { - "description": "Object identifier.", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "enum": [ - "analyticalDashboard", - "attribute", - "attributeHierarchy", - "dashboardPlugin", - "dataset", - "fact", - "label", - "metric", - "userDataFilter", - "automation", - "knowledgeRecommendation", - "visualizationObject", - "filterContext", - "filterView" - ], - "example": "metric", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "EntitySearchBody": { - "description": "Request body for entity search operations", - "properties": { - "filter": { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "nullable": true, - "type": "string" - }, - "include": { - "description": "List of related entities to include in the response", - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "metaInclude": { - "description": "Set of metadata fields to include in the response", - "items": { - "type": "string" - }, - "nullable": true, - "type": "array", - "uniqueItems": true - }, - "page": { - "$ref": "#/components/schemas/EntitySearchPage" - }, - "sort": { - "description": "Sorting criteria (can specify multiple sort orders)", - "items": { - "$ref": "#/components/schemas/EntitySearchSort" - }, - "nullable": true, - "type": "array" - } - }, - "type": "object" - }, - "EntitySearchPage": { - "description": "Pagination information for entity search", - "properties": { - "index": { - "default": 0, - "description": "Zero-based page index", - "format": "int32", - "minimum": 0, - "type": "integer" - }, - "size": { - "default": 100, - "description": "Number of items per page", - "format": "int32", - "minimum": 1, - "type": "integer" - } - }, - "required": [ - "index", - "size" - ], - "type": "object" - }, - "EntitySearchSort": { - "description": "Sorting criteria for entity search", - "properties": { - "direction": { - "default": "ASC", - "description": "Sort direction", - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - }, - "property": { - "description": "Property name to sort by", - "type": "string" - } - }, - "required": [ - "property" - ], - "type": "object" - }, - "ExecutionSettings": { - "description": "Various settings affecting the process of AFM execution or its result", - "properties": { - "dataSamplingPercentage": { - "description": "Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.", - "exclusiveMaximum": true, - "exclusiveMinimum": true, - "format": "float", - "maximum": 100, - "minimum": 0, - "type": "number" - }, - "timestamp": { - "description": "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "ExportRequest": { - "description": "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", - "example": [ - "Revenues" - ], - "oneOf": [ - { - "$ref": "#/components/schemas/VisualExportRequest" - }, - { - "$ref": "#/components/schemas/TabularExportRequest" - } - ], - "type": "object" - }, - "FactIdentifier": { - "description": "A fact identifier.", - "properties": { - "id": { - "description": "Fact ID.", - "example": "fact_id", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "A type of the fact.", - "enum": [ - "fact" - ], - "example": "fact", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "File": { - "properties": { - "any": { - "items": { - "type": "object" - }, - "type": "array" - }, - "canResegment": { - "enum": [ - "YES", - "NO" - ], - "type": "string" - }, - "id": { - "type": "string" - }, - "notes": { - "$ref": "#/components/schemas/Notes" - }, - "original": { - "type": "string" - }, - "otherAttributes": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "skeleton": { - "$ref": "#/components/schemas/Skeleton" - }, - "space": { - "type": "string" - }, - "srcDir": { - "enum": [ - "LTR", - "RTL", - "AUTO" - ], - "type": "string" - }, - "translate": { - "enum": [ - "YES", - "NO" - ], - "type": "string" - }, - "trgDir": { - "enum": [ - "LTR", - "RTL", - "AUTO" - ], - "type": "string" - }, - "unitOrGroup": { - "items": { - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - }, - "FilterDefinition": { - "description": "Abstract filter definition type", - "oneOf": [ - { - "$ref": "#/components/schemas/InlineFilterDefinition" - }, - { - "$ref": "#/components/schemas/RankingFilter" - }, - { - "$ref": "#/components/schemas/ComparisonMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/RangeMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/CompoundMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/AbsoluteDateFilter" - }, - { - "$ref": "#/components/schemas/RelativeDateFilter" - }, - { - "$ref": "#/components/schemas/NegativeAttributeFilter" - }, - { - "$ref": "#/components/schemas/PositiveAttributeFilter" - } - ], - "type": "object" - }, - "FilterDefinitionForSimpleMeasure": { - "description": "Abstract filter definition type for simple metric.", - "oneOf": [ - { - "$ref": "#/components/schemas/DateFilter" - }, - { - "$ref": "#/components/schemas/AttributeFilter" - } - ], - "type": "object" - }, - "GenerateLdmRequest": { - "description": "A request containing all information needed for generation of logical model.", - "properties": { - "aggregatedFactPrefix": { - "description": "Columns starting with this prefix will be considered as aggregated facts. The prefix is then followed by the value of `separator` parameter. Given the aggregated fact prefix is `aggr` and separator is `__`, the columns with name like `aggr__sum__product__sold` will be considered as aggregated sold fact in the product table with SUM aggregate function.", - "example": "aggr", - "type": "string" - }, - "dateGranularities": { - "description": "Option to control date granularities for date datasets. Empty value enables common date granularities (DAY, WEEK, MONTH, QUARTER, YEAR). Default value is `all` which enables all available date granularities, including time granularities (like hours, minutes).", - "example": "all", - "type": "string" - }, - "dateReferencePrefix": { - "description": "Columns starting with this prefix will be considered as references to date dataset. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `d` and separator is `__`, the columns with name like `d__date` will be considered as reference to date dataset. There can be also second separator and granularity suffix, e.g. `d__date__day` to create attribute reference to exact date dataset and granularity.", - "example": "d", - "type": "string" - }, - "denormPrefix": { - "description": "Columns starting with this prefix will be considered as denormalization references. The prefix is then followed by the value of `separator` parameter. Given the denormalization reference prefix is `dr` and separator is `__`, the columns with name like `dr__customer_name` will be considered as denormalization references.", - "example": "dr", - "type": "string" - }, - "factPrefix": { - "description": "Columns starting with this prefix will be considered as facts. The prefix is then followed by the value of `separator` parameter. Given the fact prefix is `f` and separator is `__`, the columns with name like `f__sold` will be considered as facts.", - "example": "f", - "type": "string" - }, - "generateLongIds": { - "default": false, - "description": "A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of `
.` is used. If the flag is set to true, then all ids will be generated in the long form.", - "type": "boolean" - }, - "grainMultivalueReferencePrefix": { - "description": "Columns starting with this prefix will be considered as grain multivalue references. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `grmr` and separator is `__`, the columns with name like `grmr__customer__customer_id` will be considered as grain multivalue references to customer_id in customer table.", - "example": "grmr", - "type": "string" - }, - "grainPrefix": { - "description": "Columns starting with this prefix will be considered as grains. The prefix is then followed by the value of `separator` parameter. Given the grain prefix is `gr` and separator is `__`, the columns with name like `gr__name` will be considered as grains.", - "example": "gr", - "type": "string" - }, - "grainReferencePrefix": { - "description": "Columns starting with this prefix will be considered as grain references. The prefix is then followed by the value of `separator` parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is `grr` and separator is `__`, the columns with name like `grr__customer__customer_id` will be considered as grain references to customer_id in customer table.", - "example": "grr", - "type": "string" - }, - "multivalueReferencePrefix": { - "description": "Columns starting with this prefix will be considered as multivalue references. The prefix is then followed by the value of `separator` parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is `mr` and separator is `__`, the columns with name like `mr__customer__customer_id` will be considered as multivalue references to customer_id in customer table.", - "example": "mr", - "type": "string" - }, - "pdm": { - "$ref": "#/components/schemas/PdmLdmRequest" - }, - "primaryLabelPrefix": { - "description": "Columns starting with this prefix will be considered as primary labels. The prefix is then followed by the value of `separator` parameter. Given the primary label prefix is `pl` and separator is `__`, the columns with name like `pl__country_id` will be considered as primary labels.", - "example": "pl", - "type": "string" - }, - "referencePrefix": { - "description": "Columns starting with this prefix will be considered as references. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `r` and separator is `__`, the columns with name like `r__customer__customer_id` will be considered as references to customer_id in customer table.", - "example": "r", - "type": "string" - }, - "secondaryLabelPrefix": { - "description": "Columns starting with this prefix will be considered as secondary labels. The prefix is then followed by the value of `separator` parameter. Given the secondary label prefix is `ls` and separator is `__`, the columns with name like `ls__country_id__country_name` will be considered as secondary labels.", - "example": "ls", - "type": "string" - }, - "separator": { - "default": "__", - "description": "A separator between prefixes and the names. Default is \"__\".", - "type": "string" - }, - "tablePrefix": { - "deprecated": true, - "description": "Tables starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the table prefix is `out_table` and separator is `__`, the table with name like `out_table__customers` will be scanned.", - "example": "out_table", - "type": "string" - }, - "translationPrefix": { - "description": "Columns starting with this prefix will be considered as secondary label translation. The prefix is then followed by the value of `separator` parameter. Given the translation prefix is `tr` and separator is `__`, the columns with name like `tr__attribute__label__en-US` will be considered as secondary label en-US translation to `label` label in `attribute` attribute.", - "example": "tr", - "type": "string" - }, - "viewPrefix": { - "deprecated": true, - "description": "Views starting with this prefix will be included. The prefix is then followed by the value of `separator` parameter. Given the view prefix is `out_view` and separator is `__`, the table with name like `out_view__us_customers` will be scanned.", - "example": "out_view", - "type": "string" - }, - "wdfPrefix": { - "default": "wdf", - "description": "Column serving as workspace data filter. No labels are auto generated for such columns.", - "type": "string" - }, - "workspaceId": { - "description": "Optional workspace id.", - "type": "string" - } - }, - "type": "object" - }, - "GeoAreaConfig": { - "description": "Configuration specific to geo area labels.", - "properties": { - "collection": { - "$ref": "#/components/schemas/GeoCollectionIdentifier" - } - }, - "required": [ - "collection" - ], - "type": "object" - }, - "GeoCollectionIdentifier": { - "properties": { - "id": { - "description": "Geo collection identifier.", - "maxLength": 255, - "type": "string" - }, - "kind": { - "default": "STATIC", - "description": "Type of geo collection.", - "enum": [ - "STATIC", - "CUSTOM" - ], - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "GrainIdentifier": { - "description": "A grain identifier.", - "example": { - "id": "customer_id", - "type": "attribute" - }, - "maxLength": 255, - "properties": { - "id": { - "description": "Grain ID.", - "example": "attr.customers.customer_name", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "A type of the grain.", - "enum": [ - "attribute", - "date" - ], - "example": "ATTRIBUTE", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "GrantedPermission": { - "description": "Permissions granted to the user group", - "properties": { - "level": { - "description": "Level of permission", - "example": "VIEW, SHARE, EDIT", - "type": "string" - }, - "source": { - "description": "Source of permission", - "example": "direct/indirect", - "type": "string" - } - }, - "required": [ - "level", - "source" - ], - "type": "object" - }, - "GranularitiesFormatting": { - "description": "A date dataset granularities title formatting rules.", - "properties": { - "titleBase": { - "description": "Title base is used as a token in title pattern. If left empty, it is replaced by date dataset title.", - "maxLength": 255, - "type": "string" - }, - "titlePattern": { - "description": "This pattern is used to generate the title of attributes and labels that result from the granularities.\nThere are two tokens available: \n* `%titleBase` - represents shared part by all titles, or title of Date Dataset if left empty\n* `%granularityTitle` - represents `DateGranularity` built-in title", - "example": "%titleBase - %granularityTitle", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "titleBase", - "titlePattern" - ], - "type": "object" - }, - "HierarchyObjectIdentification": { - "description": "Represents objects with given ID and type in workspace hierarchy (more than one can exists in different workspaces).", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "analyticalDashboard", - "attribute", - "dashboardPlugin", - "dataset", - "fact", - "label", - "metric", - "prompt", - "visualizationObject", - "filterContext", - "workspaceDataFilter", - "workspaceDataFilterSettings" - ], - "example": "metric", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "IdentifierDuplications": { - "description": "Contains information about conflicting IDs in workspace hierarchy", - "properties": { - "id": { - "type": "string" - }, - "origins": { - "items": { - "type": "string" - }, - "type": "array" - }, - "type": { - "enum": [ - "analyticalDashboard", - "attribute", - "dashboardPlugin", - "dataset", - "fact", - "label", - "metric", - "prompt", - "visualizationObject", - "filterContext", - "workspaceDataFilter", - "workspaceDataFilterSettings" - ], - "example": "metric", - "type": "string" - } - }, - "required": [ - "id", - "origins", - "type" - ], - "type": "object" - }, - "IdentifierRef": { - "properties": { - "identifier": { - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "analyticalDashboard", - "attribute", - "attributeHierarchy", - "dashboardPlugin", - "dataset", - "fact", - "aggregatedFact", - "label", - "metric", - "userDataFilter", - "exportDefinition", - "automation", - "automationResult", - "memoryItem", - "knowledgeRecommendation", - "prompt", - "visualizationObject", - "filterContext", - "workspaceSettings", - "customApplicationSetting", - "workspaceDataFilter", - "workspaceDataFilterSetting", - "filterView" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - } - }, - "type": "object" - }, - "ImageExportRequest": { - "description": "Export request object describing the export properties and metadata for image exports.", - "properties": { - "dashboardId": { - "description": "Dashboard identifier", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - "type": "string" - }, - "fileName": { - "description": "File name to be used for retrieving the image document.", - "example": "filename", - "type": "string" - }, - "format": { - "description": "Requested resulting file type.", - "enum": [ - "PNG" - ], - "example": "PNG", - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/JsonNode" - }, - "widgetIds": { - "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 1, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "dashboardId", - "fileName", - "format", - "widgetIds" - ], - "type": "object" - }, - "InPlatform": { - "allOf": [ - { - "properties": { - "type": { - "description": "The destination type.", - "enum": [ - "IN_PLATFORM" - ], - "type": "string" - } - }, - "type": "object" - } - ], - "description": "In-platform destination for notifications.", - "required": [ - "type" - ], - "type": "object" - }, - "InlineFilterDefinition": { - "description": "Filter in form of direct MAQL query.", - "properties": { - "inline": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "filter": { - "description": "MAQL query representing the filter.", - "type": "string" - }, - "localIdentifier": { - "type": "string" - } - }, - "required": [ - "filter" - ], - "type": "object" - } - }, - "required": [ - "inline" - ], - "type": "object" - }, - "InlineMeasureDefinition": { - "description": "Metric defined by the raw MAQL query.", - "properties": { - "inline": { - "properties": { - "maql": { - "description": "MAQL query defining the metric.", - "type": "string" - } - }, - "required": [ - "maql" - ], - "type": "object" - } - }, - "required": [ - "inline" - ], - "type": "object" - }, - "IntroSlideTemplate": { - "description": "Settings for intro slide.", - "nullable": true, - "properties": { - "backgroundImage": { - "default": true, - "description": "Show background image on the slide.", - "type": "boolean" - }, - "descriptionField": { - "example": "About:\n{{dashboardDescription}}\n\n{{dashboardFilters}}", - "nullable": true, - "type": "string" - }, - "footer": { - "$ref": "#/components/schemas/RunningSection" - }, - "header": { - "$ref": "#/components/schemas/RunningSection" - }, - "titleField": { - "example": "Introduction", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "JsonApiAggregatedFactLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "aggregatedFact" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiAggregatedFactOut": { - "description": "JSON:API representation of aggregatedFact entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "isNullable": { - "type": "boolean" - }, - "nullValue": { - "type": "string" - }, - "operation": { - "enum": [ - "SUM", - "MIN", - "MAX" - ], - "type": "string" - }, - "sourceColumn": { - "maxLength": 255, - "type": "string" - }, - "sourceColumnDataType": { - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "operation" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" + "JsonApiAttributeHierarchyOut" : { + "description" : "JSON:API representation of attributeHierarchy entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { + "attributes" : [ { + "identifier" : { + "id" : "country", + "type" : "attribute" + } + }, { + "identifier" : { + "id" : "city", + "type" : "attribute" + } + } ] + }, + "type" : "object" + }, + "createdAt" : { + "description" : "Time of the entity creation.", + "format" : "date-time", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "modifiedAt" : { + "description" : "Time of the last entity modification.", + "format" : "date-time", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" } }, - "required": [ - "originId", - "originType" - ], - "type": "object" + "required" : [ "originId", "originType" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "relationships": { - "properties": { - "dataset": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDatasetToOneLinkage" + "relationships" : { + "properties" : { + "attributes" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAttributeToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "createdBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "sourceFact": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFactToOneLinkage" + "modifiedBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "aggregatedFact" - ], - "example": "aggregatedFact", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "attributeHierarchy" ], + "example" : "attributeHierarchy", + "type" : "string" } }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiAggregatedFactOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOut" + "JsonApiAttributeHierarchyOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOut" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutIncludes" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOutIncludes" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiAggregatedFactOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiFactOutWithLinks" - } - ] + "JsonApiAttributeHierarchyOutIncludes" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiAttributeOutWithLinks" + } ] }, - "JsonApiAggregatedFactOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutWithLinks" + "JsonApiAttributeHierarchyOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutIncludes" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOutIncludes" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiAttributeHierarchyOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] }, - "JsonApiAggregatedFactOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiAggregatedFactOut" + "JsonApiAttributeHierarchyPatch" : { + "description" : "JSON:API representation of patching attributeHierarchy entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { + "attributes" : [ { + "identifier" : { + "id" : "country", + "type" : "attribute" + } + }, { + "identifier" : { + "id" : "city", + "type" : "attribute" + } + } ] + }, + "type" : "object" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "attributeHierarchy" ], + "example" : "attributeHierarchy", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiAttributeHierarchyPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyPatch" } - ] + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiAttributeHierarchyToManyLinkage" : { + "description" : "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyLinkage" + }, + "type" : "array" }, - "JsonApiAggregatedFactToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiAggregatedFactLinkage" + "JsonApiAttributeLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "attribute" ], + "type" : "string" + } }, - "type": "array" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiAnalyticalDashboardIn": { - "description": "JSON:API representation of analyticalDashboard entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" + "JsonApiAttributeOut" : { + "description" : "JSON:API representation of attribute entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - }, - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "summary": { - "description": "AI-generated summary of the dashboard content", - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "analyticalDashboard" - ], - "example": "analyticalDashboard", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiAnalyticalDashboardInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiAnalyticalDashboardLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "analyticalDashboard" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiAnalyticalDashboardOut": { - "description": "JSON:API representation of analyticalDashboard entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - }, - "type": "object" + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "granularity" : { + "enum" : [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], + "type" : "string" + }, + "isHidden" : { + "type" : "boolean" }, - "createdAt": { - "format": "date-time", - "type": "string" + "isNullable" : { + "type" : "boolean" }, - "description": { - "maxLength": 10000, - "type": "string" + "locale" : { + "type" : "string" }, - "modifiedAt": { - "format": "date-time", - "type": "string" + "nullValue" : { + "type" : "string" }, - "summary": { - "description": "AI-generated summary of the dashboard content", - "maxLength": 10000, - "type": "string" + "sortColumn" : { + "maxLength" : 255, + "type" : "string" }, - "tags": { - "items": { - "type": "string" + "sortDirection" : { + "enum" : [ "ASC", "DESC" ], + "type" : "string" + }, + "sourceColumn" : { + "maxLength" : 255, + "type" : "string" + }, + "sourceColumnDataType" : { + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" }, - "type": "array" + "type" : "array" }, - "title": { - "maxLength": 255, - "type": "string" + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "required": [ - "content" - ], - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "meta": { - "properties": { - "accessInfo": { - "properties": { - "private": { - "description": "is the entity private to the currently logged-in user", - "type": "boolean" + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" + }, + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" } }, - "required": [ - "private" - ], - "type": "object" - }, - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" - }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" - } - }, - "required": [ - "originId", - "originType" - ], - "type": "object" - }, - "permissions": { - "description": "List of valid permissions for a logged-in user.", - "items": { - "enum": [ - "EDIT", - "SHARE", - "VIEW" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "analyticalDashboards": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "createdBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "dashboardPlugins": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDashboardPluginToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "datasets": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "filterContexts": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFilterContextToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "labels": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" + "required" : [ "originId", "originType" ], + "type" : "object" + } + }, + "type" : "object" + }, + "relationships" : { + "properties" : { + "attributeHierarchies" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyToManyLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "metrics": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" + "dataset" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDatasetToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "modifiedBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + "defaultView" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiLabelToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "visualizationObjects": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectToManyLinkage" + "labels" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiLabelToManyLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "analyticalDashboard" - ], - "example": "analyticalDashboard", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "attribute" ], + "example" : "attribute", + "type" : "string" } }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiAnalyticalDashboardOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOut" + "JsonApiAttributeOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAttributeOut" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutIncludes" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiAttributeOutIncludes" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiAnalyticalDashboardOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiFilterContextOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutWithLinks" - } - ] + "JsonApiAttributeOutIncludes" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiDatasetOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiLabelOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOutWithLinks" + } ] }, - "JsonApiAnalyticalDashboardOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" + "JsonApiAttributeOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiAttributeOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutIncludes" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiAttributeOutIncludes" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiAnalyticalDashboardOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "JsonApiAttributeOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiAttributeOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] }, - "JsonApiAnalyticalDashboardPatch": { - "description": "JSON:API representation of patching analyticalDashboard entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" + "JsonApiAttributePatch" : { + "description" : "JSON:API representation of patching attribute entity.", + "properties" : { + "attributes" : { + "properties" : { + "description" : { + "maxLength" : 10000, + "type" : "string" }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - }, - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "summary": { - "description": "AI-generated summary of the dashboard content", - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "analyticalDashboard" - ], - "example": "analyticalDashboard", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiAnalyticalDashboardPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiAnalyticalDashboardPostOptionalId": { - "description": "JSON:API representation of analyticalDashboard entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - }, - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "summary": { - "description": "AI-generated summary of the dashboard content", - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "analyticalDashboard" - ], - "example": "analyticalDashboard", - "type": "string" - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - }, - "JsonApiAnalyticalDashboardPostOptionalIdDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalId" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiAnalyticalDashboardToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardLinkage" - }, - "type": "array" - }, - "JsonApiAnalyticalDashboardToOneLinkage": { - "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "nullable": true, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardLinkage" - } - ] - }, - "JsonApiApiTokenIn": { - "description": "JSON:API representation of apiToken entity.", - "properties": { - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "apiToken" - ], - "example": "apiToken", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiApiTokenInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiApiTokenIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiApiTokenOut": { - "description": "JSON:API representation of apiToken entity.", - "properties": { - "attributes": { - "properties": { - "bearerToken": { - "description": "The value of the Bearer token. It is only returned when the API token is created.", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "apiToken" - ], - "example": "apiToken", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiApiTokenOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiApiTokenOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiApiTokenOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiApiTokenOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiApiTokenOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiApiTokenOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiAttributeHierarchyIn": { - "description": "JSON:API representation of attributeHierarchy entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": { - "attributes": [ - { - "identifier": { - "id": "country", - "type": "attribute" - } - }, - { - "identifier": { - "id": "city", - "type": "attribute" - } - } - ] - }, - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "attributeHierarchy" - ], - "example": "attributeHierarchy", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiAttributeHierarchyInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiAttributeHierarchyLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "attributeHierarchy" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiAttributeHierarchyOut": { - "description": "JSON:API representation of attributeHierarchy entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": { - "attributes": [ - { - "identifier": { - "id": "country", - "type": "attribute" - } - }, - { - "identifier": { - "id": "city", - "type": "attribute" - } - } - ] - }, - "type": "object" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "modifiedAt": { - "format": "date-time", - "type": "string" - }, - "tags": { - "items": { - "type": "string" + "tags" : { + "items" : { + "type" : "string" }, - "type": "array" + "type" : "array" }, - "title": { - "maxLength": 255, - "type": "string" + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "type" : "object" }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" - }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" - } - }, - "required": [ - "originId", - "originType" - ], - "type": "object" - } - }, - "type": "object" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "relationships": { - "properties": { - "attributes": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "createdBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + "relationships" : { + "properties" : { + "defaultView" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiLabelToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" - }, - "modifiedBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "attributeHierarchy" - ], - "example": "attributeHierarchy", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "attribute" ], + "example" : "attribute", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiAttributeHierarchyOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOut" - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutIncludes" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "JsonApiAttributePatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAttributePatch" } }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiAttributeHierarchyOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" - } - ] + "required" : [ "data" ], + "type" : "object" }, - "JsonApiAttributeHierarchyOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutIncludes" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } + "JsonApiAttributeToManyLinkage" : { + "description" : "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items" : { + "$ref" : "#/components/schemas/JsonApiAttributeLinkage" }, - "required": [ - "data" - ], - "type": "object" + "type" : "array" }, - "JsonApiAttributeHierarchyOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "JsonApiAttributeToOneLinkage" : { + "description" : "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiAttributeLinkage" + } ] }, - "JsonApiAttributeHierarchyPatch": { - "description": "JSON:API representation of patching attributeHierarchy entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": { - "attributes": [ - { - "identifier": { - "id": "country", - "type": "attribute" - } - }, - { - "identifier": { - "id": "city", - "type": "attribute" - } - } - ] - }, - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "attributeHierarchy" - ], - "example": "attributeHierarchy", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiAttributeHierarchyPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiAttributeHierarchyToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyLinkage" - }, - "type": "array" - }, - "JsonApiAttributeLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "attribute" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiAttributeOut": { - "description": "JSON:API representation of attribute entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "granularity": { - "enum": [ - "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", - "MINUTE_OF_HOUR", - "HOUR_OF_DAY", - "DAY_OF_WEEK", - "DAY_OF_MONTH", - "DAY_OF_QUARTER", - "DAY_OF_YEAR", - "WEEK_OF_YEAR", - "MONTH_OF_YEAR", - "QUARTER_OF_YEAR", - "FISCAL_MONTH", - "FISCAL_QUARTER", - "FISCAL_YEAR" - ], - "type": "string" - }, - "isHidden": { - "type": "boolean" - }, - "isNullable": { - "type": "boolean" - }, - "locale": { - "type": "string" - }, - "nullValue": { - "type": "string" - }, - "sortColumn": { - "maxLength": 255, - "type": "string" - }, - "sortDirection": { - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - }, - "sourceColumn": { - "maxLength": 255, - "type": "string" - }, - "sourceColumnDataType": { - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" + "JsonApiAutomationIn" : { + "description" : "JSON:API representation of automation entity.", + "properties" : { + "attributes" : { + "properties" : { + "alert" : { + "properties" : { + "condition" : { + "$ref" : "#/components/schemas/AlertCondition" }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" - } - }, - "required": [ - "originId", - "originType" - ], - "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "attributeHierarchies": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "dataset": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDatasetToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "defaultView": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiLabelToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "labels": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "attribute" - ], - "example": "attribute", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiAttributeOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeOut" - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiAttributeOutIncludes" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiAttributeOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutWithLinks" - } - ] - }, - "JsonApiAttributeOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiAttributeOutIncludes" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiAttributeOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiAttributeOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiAttributePatch": { - "description": "JSON:API representation of patching attribute entity.", - "properties": { - "attributes": { - "properties": { - "description": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "defaultView": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiLabelToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "attribute" - ], - "example": "attribute", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiAttributePatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributePatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiAttributeToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiAttributeLinkage" - }, - "type": "array" - }, - "JsonApiAttributeToOneLinkage": { - "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "nullable": true, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiAttributeLinkage" - } - ] - }, - "JsonApiAutomationIn": { - "description": "JSON:API representation of automation entity.", - "properties": { - "attributes": { - "properties": { - "alert": { - "properties": { - "condition": { - "$ref": "#/components/schemas/AlertCondition" + "execution" : { + "$ref" : "#/components/schemas/AlertAfm" }, - "execution": { - "$ref": "#/components/schemas/AlertAfm" + "interval" : { + "description" : "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", + "enum" : [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], + "type" : "string" }, - "trigger": { - "default": "ALWAYS", - "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\n", - "enum": [ - "ALWAYS", - "ONCE" - ], - "type": "string" + "trigger" : { + "default" : "ALWAYS", + "description" : "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", + "enum" : [ "ALWAYS", "ONCE", "ONCE_PER_INTERVAL" ], + "type" : "string" } }, - "required": [ - "condition", - "execution" - ], - "type": "object" + "required" : [ "condition", "execution" ], + "type" : "object" }, - "areRelationsValid": { - "type": "boolean" + "areRelationsValid" : { + "type" : "boolean" }, - "dashboardTabularExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/DashboardTabularExportRequestV2" + "dashboardTabularExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/DashboardTabularExportRequestV2" } }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "details": { - "description": "Additional details to be included in the automated message.", - "maxLength": 10000, - "type": "object" - }, - "evaluationMode": { - "description": "Specify automation evaluation mode.", - "enum": [ - "SHARED", - "PER_RECIPIENT" - ], - "type": "string" - }, - "externalRecipients": { - "description": "External recipients of the automation action results.", - "items": { - "properties": { - "email": { - "description": "E-mail address to send notifications from.", - "format": "email", - "type": "string" + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "details" : { + "description" : "Additional details to be included in the automated message.", + "maxLength" : 10000, + "type" : "object" + }, + "evaluationMode" : { + "description" : "Specify automation evaluation mode.", + "enum" : [ "SHARED", "PER_RECIPIENT" ], + "type" : "string" + }, + "externalRecipients" : { + "description" : "External recipients of the automation action results.", + "items" : { + "properties" : { + "email" : { + "description" : "E-mail address to send notifications from.", + "format" : "email", + "type" : "string" } }, - "required": [ - "email" - ], - "type": "object" - }, - "type": "array" - }, - "imageExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/ImageExportRequest" + "required" : [ "email" ], + "type" : "object" + }, + "type" : "array" + }, + "imageExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/ImageExportRequest" } }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "metadata": { - "additionalProperties": true, - "description": "Additional information for the automation.", - "maxLength": 250000, - "nullable": true, - "properties": { - "visibleFilters": { - "items": { - "$ref": "#/components/schemas/VisibleFilter" + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + }, + "metadata" : { + "description" : "Additional information for the automation.", + "maxLength" : 250000, + "nullable" : true, + "properties" : { + "visibleFilters" : { + "items" : { + "$ref" : "#/components/schemas/VisibleFilter" }, - "type": "array" + "type" : "array" }, - "widget": { - "type": "string" + "widget" : { + "type" : "string" } }, - "type": "object" + "type" : "object" }, - "rawExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/RawExportAutomationRequest" + "rawExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/RawExportAutomationRequest" } }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "schedule": { - "properties": { - "cron": { - "description": "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", - "example": "0 */30 9-17 ? * MON-FRI", - "maxLength": 255, - "type": "string" + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + }, + "schedule" : { + "properties" : { + "cron" : { + "description" : "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", + "example" : "0 */30 9-17 ? * MON-FRI", + "maxLength" : 255, + "type" : "string" }, - "cronDescription": { - "description": "Human-readable description of the cron expression.", - "readOnly": true, - "type": "string" + "cronDescription" : { + "description" : "Human-readable description of the cron expression.", + "readOnly" : true, + "type" : "string" }, - "firstRun": { - "description": "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", - "example": "2025-01-01T12:00:00Z", - "format": "date-time", - "type": "string" + "firstRun" : { + "description" : "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", + "example" : "2025-01-01T12:00:00Z", + "format" : "date-time", + "type" : "string" }, - "timezone": { - "description": "Timezone in which the schedule is defined.", - "example": "Europe/Prague", - "maxLength": 255, - "type": "string" + "timezone" : { + "description" : "Timezone in which the schedule is defined.", + "example" : "Europe/Prague", + "maxLength" : 255, + "type" : "string" } }, - "required": [ - "cron", - "timezone" - ], - "type": "object" - }, - "slidesExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/SlidesExportRequest" + "required" : [ "cron", "timezone" ], + "type" : "object" + }, + "slidesExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/SlidesExportRequest" } }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "state": { - "description": "Current state of the automation.", - "enum": [ - "ACTIVE", - "PAUSED" - ], - "type": "string" - }, - "tabularExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/TabularExportRequest" + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + }, + "state" : { + "description" : "Current state of the automation.", + "enum" : [ "ACTIVE", "PAUSED" ], + "type" : "string" + }, + "tabularExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/TabularExportRequest" } }, - "required": [ - "requestPayload" - ], - "type": "object" + "required" : [ "requestPayload" ], + "type" : "object" }, - "type": "array" + "type" : "array" }, - "tags": { - "items": { - "type": "string" + "tags" : { + "items" : { + "type" : "string" }, - "type": "array" + "type" : "array" }, - "title": { - "maxLength": 255, - "type": "string" + "title" : { + "maxLength" : 255, + "type" : "string" }, - "visualExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/VisualExportRequest" + "visualExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/VisualExportRequest" } }, - "required": [ - "requestPayload" - ], - "type": "object" + "required" : [ "requestPayload" ], + "type" : "object" }, - "type": "array" + "type" : "array" } }, - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "relationships": { - "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" + "relationships" : { + "properties" : { + "analyticalDashboard" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "exportDefinitions": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiExportDefinitionToManyLinkage" + "exportDefinitions" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionToManyLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "notificationChannel": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiNotificationChannelToOneLinkage" + "notificationChannel" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "recipients": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToManyLinkage" + "recipients" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserToManyLinkage" } }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "automation" - ], - "example": "automation", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiAutomationInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAutomationIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiAutomationLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "automation" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiAutomationOut": { - "description": "JSON:API representation of automation entity.", - "properties": { - "attributes": { - "properties": { - "alert": { - "properties": { - "condition": { - "$ref": "#/components/schemas/AlertCondition" + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "automation" ], + "example" : "automation", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiAutomationInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAutomationIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiAutomationLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "automation" ], + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiAutomationOut" : { + "description" : "JSON:API representation of automation entity.", + "properties" : { + "attributes" : { + "properties" : { + "alert" : { + "properties" : { + "condition" : { + "$ref" : "#/components/schemas/AlertCondition" + }, + "execution" : { + "$ref" : "#/components/schemas/AlertAfm" }, - "execution": { - "$ref": "#/components/schemas/AlertAfm" + "interval" : { + "description" : "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", + "enum" : [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], + "type" : "string" }, - "trigger": { - "default": "ALWAYS", - "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\n", - "enum": [ - "ALWAYS", - "ONCE" - ], - "type": "string" + "trigger" : { + "default" : "ALWAYS", + "description" : "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", + "enum" : [ "ALWAYS", "ONCE", "ONCE_PER_INTERVAL" ], + "type" : "string" } }, - "required": [ - "condition", - "execution" - ], - "type": "object" + "required" : [ "condition", "execution" ], + "type" : "object" }, - "areRelationsValid": { - "type": "boolean" + "areRelationsValid" : { + "type" : "boolean" }, - "createdAt": { - "format": "date-time", - "type": "string" + "createdAt" : { + "description" : "Time of the entity creation.", + "format" : "date-time", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" }, - "dashboardTabularExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/DashboardTabularExportRequestV2" + "dashboardTabularExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/DashboardTabularExportRequestV2" } }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "details": { - "description": "Additional details to be included in the automated message.", - "maxLength": 10000, - "type": "object" - }, - "evaluationMode": { - "description": "Specify automation evaluation mode.", - "enum": [ - "SHARED", - "PER_RECIPIENT" - ], - "type": "string" - }, - "externalRecipients": { - "description": "External recipients of the automation action results.", - "items": { - "properties": { - "email": { - "description": "E-mail address to send notifications from.", - "format": "email", - "type": "string" + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "details" : { + "description" : "Additional details to be included in the automated message.", + "maxLength" : 10000, + "type" : "object" + }, + "evaluationMode" : { + "description" : "Specify automation evaluation mode.", + "enum" : [ "SHARED", "PER_RECIPIENT" ], + "type" : "string" + }, + "externalRecipients" : { + "description" : "External recipients of the automation action results.", + "items" : { + "properties" : { + "email" : { + "description" : "E-mail address to send notifications from.", + "format" : "email", + "type" : "string" } }, - "required": [ - "email" - ], - "type": "object" - }, - "type": "array" - }, - "imageExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/ImageExportRequest" + "required" : [ "email" ], + "type" : "object" + }, + "type" : "array" + }, + "imageExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/ImageExportRequest" } }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "metadata": { - "additionalProperties": true, - "description": "Additional information for the automation.", - "maxLength": 250000, - "nullable": true, - "properties": { - "visibleFilters": { - "items": { - "$ref": "#/components/schemas/VisibleFilter" + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + }, + "metadata" : { + "description" : "Additional information for the automation.", + "maxLength" : 250000, + "nullable" : true, + "properties" : { + "visibleFilters" : { + "items" : { + "$ref" : "#/components/schemas/VisibleFilter" }, - "type": "array" + "type" : "array" }, - "widget": { - "type": "string" + "widget" : { + "type" : "string" } }, - "type": "object" + "type" : "object" }, - "modifiedAt": { - "format": "date-time", - "type": "string" + "modifiedAt" : { + "description" : "Time of the last entity modification.", + "format" : "date-time", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" }, - "rawExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/RawExportAutomationRequest" + "rawExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/RawExportAutomationRequest" } }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "schedule": { - "properties": { - "cron": { - "description": "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", - "example": "0 */30 9-17 ? * MON-FRI", - "maxLength": 255, - "type": "string" + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + }, + "schedule" : { + "properties" : { + "cron" : { + "description" : "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", + "example" : "0 */30 9-17 ? * MON-FRI", + "maxLength" : 255, + "type" : "string" }, - "cronDescription": { - "description": "Human-readable description of the cron expression.", - "readOnly": true, - "type": "string" + "cronDescription" : { + "description" : "Human-readable description of the cron expression.", + "readOnly" : true, + "type" : "string" }, - "firstRun": { - "description": "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", - "example": "2025-01-01T12:00:00Z", - "format": "date-time", - "type": "string" + "firstRun" : { + "description" : "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", + "example" : "2025-01-01T12:00:00Z", + "format" : "date-time", + "type" : "string" }, - "timezone": { - "description": "Timezone in which the schedule is defined.", - "example": "Europe/Prague", - "maxLength": 255, - "type": "string" + "timezone" : { + "description" : "Timezone in which the schedule is defined.", + "example" : "Europe/Prague", + "maxLength" : 255, + "type" : "string" } }, - "required": [ - "cron", - "timezone" - ], - "type": "object" - }, - "slidesExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/SlidesExportRequest" + "required" : [ "cron", "timezone" ], + "type" : "object" + }, + "slidesExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/SlidesExportRequest" } }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "state": { - "description": "Current state of the automation.", - "enum": [ - "ACTIVE", - "PAUSED" - ], - "type": "string" - }, - "tabularExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/TabularExportRequest" + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + }, + "state" : { + "description" : "Current state of the automation.", + "enum" : [ "ACTIVE", "PAUSED" ], + "type" : "string" + }, + "tabularExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/TabularExportRequest" } }, - "required": [ - "requestPayload" - ], - "type": "object" + "required" : [ "requestPayload" ], + "type" : "object" }, - "type": "array" + "type" : "array" }, - "tags": { - "items": { - "type": "string" + "tags" : { + "items" : { + "type" : "string" }, - "type": "array" + "type" : "array" }, - "title": { - "maxLength": 255, - "type": "string" + "title" : { + "maxLength" : 255, + "type" : "string" }, - "visualExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/VisualExportRequest" + "visualExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/VisualExportRequest" } }, - "required": [ - "requestPayload" - ], - "type": "object" + "required" : [ "requestPayload" ], + "type" : "object" }, - "type": "array" + "type" : "array" } }, - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" } }, - "required": [ - "originId", - "originType" - ], - "type": "object" + "required" : [ "originId", "originType" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "relationships": { - "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" + "relationships" : { + "properties" : { + "analyticalDashboard" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "automationResults": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAutomationResultToManyLinkage" + "automationResults" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAutomationResultToManyLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "createdBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + "createdBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "exportDefinitions": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiExportDefinitionToManyLinkage" + "exportDefinitions" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionToManyLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "modifiedBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + "modifiedBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "notificationChannel": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiNotificationChannelToOneLinkage" + "notificationChannel" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "recipients": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToManyLinkage" + "recipients" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserToManyLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "automation" - ], - "example": "automation", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "automation" ], + "example" : "automation", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiAutomationOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAutomationOut" + "JsonApiAutomationOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAutomationOut" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiAutomationOutIncludes" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiAutomationOutIncludes" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiAutomationOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiUserOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiAutomationResultOutWithLinks" - } - ] + "JsonApiAutomationOutIncludes" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiNotificationChannelOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiUserOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiAutomationResultOutWithLinks" + } ] }, - "JsonApiAutomationOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiAutomationOutWithLinks" + "JsonApiAutomationOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiAutomationOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiAutomationOutIncludes" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiAutomationOutIncludes" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiAutomationOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiAutomationOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "JsonApiAutomationOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiAutomationOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] }, - "JsonApiAutomationPatch": { - "description": "JSON:API representation of patching automation entity.", - "properties": { - "attributes": { - "properties": { - "alert": { - "properties": { - "condition": { - "$ref": "#/components/schemas/AlertCondition" + "JsonApiAutomationPatch" : { + "description" : "JSON:API representation of patching automation entity.", + "properties" : { + "attributes" : { + "properties" : { + "alert" : { + "properties" : { + "condition" : { + "$ref" : "#/components/schemas/AlertCondition" }, - "execution": { - "$ref": "#/components/schemas/AlertAfm" + "execution" : { + "$ref" : "#/components/schemas/AlertAfm" }, - "trigger": { - "default": "ALWAYS", - "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\n", - "enum": [ - "ALWAYS", - "ONCE" - ], - "type": "string" + "interval" : { + "description" : "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", + "enum" : [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], + "type" : "string" + }, + "trigger" : { + "default" : "ALWAYS", + "description" : "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", + "enum" : [ "ALWAYS", "ONCE", "ONCE_PER_INTERVAL" ], + "type" : "string" } }, - "required": [ - "condition", - "execution" - ], - "type": "object" + "required" : [ "condition", "execution" ], + "type" : "object" }, - "areRelationsValid": { - "type": "boolean" + "areRelationsValid" : { + "type" : "boolean" }, - "dashboardTabularExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/DashboardTabularExportRequestV2" + "dashboardTabularExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/DashboardTabularExportRequestV2" } }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "details": { - "description": "Additional details to be included in the automated message.", - "maxLength": 10000, - "type": "object" - }, - "evaluationMode": { - "description": "Specify automation evaluation mode.", - "enum": [ - "SHARED", - "PER_RECIPIENT" - ], - "type": "string" - }, - "externalRecipients": { - "description": "External recipients of the automation action results.", - "items": { - "properties": { - "email": { - "description": "E-mail address to send notifications from.", - "format": "email", - "type": "string" + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "details" : { + "description" : "Additional details to be included in the automated message.", + "maxLength" : 10000, + "type" : "object" + }, + "evaluationMode" : { + "description" : "Specify automation evaluation mode.", + "enum" : [ "SHARED", "PER_RECIPIENT" ], + "type" : "string" + }, + "externalRecipients" : { + "description" : "External recipients of the automation action results.", + "items" : { + "properties" : { + "email" : { + "description" : "E-mail address to send notifications from.", + "format" : "email", + "type" : "string" } }, - "required": [ - "email" - ], - "type": "object" - }, - "type": "array" - }, - "imageExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/ImageExportRequest" + "required" : [ "email" ], + "type" : "object" + }, + "type" : "array" + }, + "imageExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/ImageExportRequest" } }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "metadata": { - "additionalProperties": true, - "description": "Additional information for the automation.", - "maxLength": 250000, - "nullable": true, - "properties": { - "visibleFilters": { - "items": { - "$ref": "#/components/schemas/VisibleFilter" + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + }, + "metadata" : { + "description" : "Additional information for the automation.", + "maxLength" : 250000, + "nullable" : true, + "properties" : { + "visibleFilters" : { + "items" : { + "$ref" : "#/components/schemas/VisibleFilter" }, - "type": "array" + "type" : "array" }, - "widget": { - "type": "string" + "widget" : { + "type" : "string" } }, - "type": "object" + "type" : "object" }, - "rawExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/RawExportAutomationRequest" + "rawExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/RawExportAutomationRequest" } }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "schedule": { - "properties": { - "cron": { - "description": "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", - "example": "0 */30 9-17 ? * MON-FRI", - "maxLength": 255, - "type": "string" + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + }, + "schedule" : { + "properties" : { + "cron" : { + "description" : "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", + "example" : "0 */30 9-17 ? * MON-FRI", + "maxLength" : 255, + "type" : "string" }, - "cronDescription": { - "description": "Human-readable description of the cron expression.", - "readOnly": true, - "type": "string" + "cronDescription" : { + "description" : "Human-readable description of the cron expression.", + "readOnly" : true, + "type" : "string" }, - "firstRun": { - "description": "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", - "example": "2025-01-01T12:00:00Z", - "format": "date-time", - "type": "string" + "firstRun" : { + "description" : "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", + "example" : "2025-01-01T12:00:00Z", + "format" : "date-time", + "type" : "string" }, - "timezone": { - "description": "Timezone in which the schedule is defined.", - "example": "Europe/Prague", - "maxLength": 255, - "type": "string" + "timezone" : { + "description" : "Timezone in which the schedule is defined.", + "example" : "Europe/Prague", + "maxLength" : 255, + "type" : "string" } }, - "required": [ - "cron", - "timezone" - ], - "type": "object" - }, - "slidesExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/SlidesExportRequest" + "required" : [ "cron", "timezone" ], + "type" : "object" + }, + "slidesExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/SlidesExportRequest" } }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "state": { - "description": "Current state of the automation.", - "enum": [ - "ACTIVE", - "PAUSED" - ], - "type": "string" - }, - "tabularExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/TabularExportRequest" + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + }, + "state" : { + "description" : "Current state of the automation.", + "enum" : [ "ACTIVE", "PAUSED" ], + "type" : "string" + }, + "tabularExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/TabularExportRequest" } }, - "required": [ - "requestPayload" - ], - "type": "object" + "required" : [ "requestPayload" ], + "type" : "object" }, - "type": "array" + "type" : "array" }, - "tags": { - "items": { - "type": "string" + "tags" : { + "items" : { + "type" : "string" }, - "type": "array" + "type" : "array" }, - "title": { - "maxLength": 255, - "type": "string" + "title" : { + "maxLength" : 255, + "type" : "string" }, - "visualExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/VisualExportRequest" + "visualExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/VisualExportRequest" } }, - "required": [ - "requestPayload" - ], - "type": "object" + "required" : [ "requestPayload" ], + "type" : "object" }, - "type": "array" + "type" : "array" } }, - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "relationships": { - "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" + "relationships" : { + "properties" : { + "analyticalDashboard" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "exportDefinitions": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiExportDefinitionToManyLinkage" + "exportDefinitions" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionToManyLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "notificationChannel": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiNotificationChannelToOneLinkage" + "notificationChannel" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "recipients": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "automation" - ], - "example": "automation", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiAutomationPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAutomationPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiAutomationResultLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "automationResult" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiAutomationResultOut": { - "description": "JSON:API representation of automationResult entity.", - "properties": { - "attributes": { - "properties": { - "errorMessage": { - "maxLength": 10000, - "type": "string" - }, - "executedAt": { - "description": "Timestamp of the last automation run.", - "format": "date-time", - "type": "string" - }, - "status": { - "description": "Status of the last automation run.", - "enum": [ - "SUCCESS", - "FAILED" - ], - "type": "string" - }, - "traceId": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "executedAt", - "status" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "automation": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAutomationToOneLinkage" + "recipients" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserToManyLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "automationResult" - ], - "example": "automationResult", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "automation" ], + "example" : "automation", + "type" : "string" } }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiAutomationResultOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiAutomationResultOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiAutomationOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiAutomationResultOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiAutomationResultOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiAutomationResultToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiAutomationResultLinkage" - }, - "type": "array" - }, - "JsonApiAutomationToOneLinkage": { - "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "nullable": true, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiAutomationLinkage" - } - ] - }, - "JsonApiColorPaletteIn": { - "description": "JSON:API representation of colorPalette entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "name": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content", - "name" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "colorPalette" - ], - "example": "colorPalette", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiColorPaletteInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiColorPaletteIn" + "JsonApiAutomationPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAutomationPatch" } }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiColorPaletteOut": { - "description": "JSON:API representation of colorPalette entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "name": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content", - "name" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "colorPalette" - ], - "example": "colorPalette", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiColorPaletteOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiColorPaletteOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiColorPaletteOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiColorPaletteOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiColorPaletteOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiColorPalettePatch": { - "description": "JSON:API representation of patching colorPalette entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "name": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "colorPalette" - ], - "example": "colorPalette", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiColorPalettePatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiColorPalettePatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCookieSecurityConfigurationIn": { - "description": "JSON:API representation of cookieSecurityConfiguration entity.", - "properties": { - "attributes": { - "properties": { - "lastRotation": { - "format": "date-time", - "type": "string" - }, - "rotationInterval": { - "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", - "example": "P30D", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "cookieSecurityConfiguration" - ], - "example": "cookieSecurityConfiguration", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiCookieSecurityConfigurationInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCookieSecurityConfigurationOut": { - "description": "JSON:API representation of cookieSecurityConfiguration entity.", - "properties": { - "attributes": { - "properties": { - "lastRotation": { - "format": "date-time", - "type": "string" - }, - "rotationInterval": { - "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", - "example": "P30D", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "cookieSecurityConfiguration" - ], - "example": "cookieSecurityConfiguration", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiCookieSecurityConfigurationOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCookieSecurityConfigurationPatch": { - "description": "JSON:API representation of patching cookieSecurityConfiguration entity.", - "properties": { - "attributes": { - "properties": { - "lastRotation": { - "format": "date-time", - "type": "string" - }, - "rotationInterval": { - "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", - "example": "P30D", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "cookieSecurityConfiguration" - ], - "example": "cookieSecurityConfiguration", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiCookieSecurityConfigurationPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCspDirectiveIn": { - "description": "JSON:API representation of cspDirective entity.", - "properties": { - "attributes": { - "properties": { - "sources": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "sources" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "cspDirective" - ], - "example": "cspDirective", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiCspDirectiveInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCspDirectiveIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCspDirectiveOut": { - "description": "JSON:API representation of cspDirective entity.", - "properties": { - "attributes": { - "properties": { - "sources": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "sources" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "cspDirective" - ], - "example": "cspDirective", - "type": "string" - } + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiAutomationResultLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "automationResult" ], + "type" : "string" + } }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiCspDirectiveOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCspDirectiveOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCspDirectiveOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiCspDirectiveOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiCspDirectivePatch": { - "description": "JSON:API representation of patching cspDirective entity.", - "properties": { - "attributes": { - "properties": { - "sources": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "cspDirective" - ], - "example": "cspDirective", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiCspDirectivePatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCspDirectivePatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCustomApplicationSettingIn": { - "description": "JSON:API representation of customApplicationSetting entity.", - "properties": { - "attributes": { - "properties": { - "applicationName": { - "maxLength": 255, - "type": "string" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - } - }, - "required": [ - "applicationName", - "content" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "customApplicationSetting" - ], - "example": "customApplicationSetting", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiCustomApplicationSettingInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCustomApplicationSettingOut": { - "description": "JSON:API representation of customApplicationSetting entity.", - "properties": { - "attributes": { - "properties": { - "applicationName": { - "maxLength": 255, - "type": "string" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - } - }, - "required": [ - "applicationName", - "content" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" - }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiAutomationResultOut" : { + "description" : "JSON:API representation of automationResult entity.", + "properties" : { + "attributes" : { + "properties" : { + "errorMessage" : { + "maxLength" : 10000, + "type" : "string" + }, + "executedAt" : { + "description" : "Timestamp of the last automation run.", + "format" : "date-time", + "type" : "string" + }, + "status" : { + "description" : "Status of the last automation run.", + "enum" : [ "SUCCESS", "FAILED" ], + "type" : "string" + }, + "traceId" : { + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "executedAt", "status" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "automation" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAutomationToOneLinkage" } }, - "required": [ - "originId", - "originType" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "customApplicationSetting" - ], - "example": "customApplicationSetting", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "automationResult" ], + "example" : "automationResult", + "type" : "string" } }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiCustomApplicationSettingOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOut" + "JsonApiAutomationResultOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiAutomationResultOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCustomApplicationSettingOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutWithLinks" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiAutomationOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCustomApplicationSettingOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } + }, + "type" : "object" } - ] - }, - "JsonApiCustomApplicationSettingPatch": { - "description": "JSON:API representation of patching customApplicationSetting entity.", - "properties": { - "attributes": { - "properties": { - "applicationName": { - "maxLength": 255, - "type": "string" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "customApplicationSetting" - ], - "example": "customApplicationSetting", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiCustomApplicationSettingPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCustomApplicationSettingPostOptionalId": { - "description": "JSON:API representation of customApplicationSetting entity.", - "properties": { - "attributes": { - "properties": { - "applicationName": { - "maxLength": 255, - "type": "string" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - } - }, - "required": [ - "applicationName", - "content" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "customApplicationSetting" - ], - "example": "customApplicationSetting", - "type": "string" - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - }, - "JsonApiCustomApplicationSettingPostOptionalIdDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalId" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCustomGeoCollectionIn": { - "description": "JSON:API representation of customGeoCollection entity.", - "properties": { - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "customGeoCollection" - ], - "example": "customGeoCollection", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiCustomGeoCollectionInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCustomGeoCollectionOut": { - "description": "JSON:API representation of customGeoCollection entity.", - "properties": { - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "customGeoCollection" - ], - "example": "customGeoCollection", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiCustomGeoCollectionOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCustomGeoCollectionOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCustomGeoCollectionOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiCustomGeoCollectionPatch": { - "description": "JSON:API representation of patching customGeoCollection entity.", - "properties": { - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "customGeoCollection" - ], - "example": "customGeoCollection", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiCustomGeoCollectionPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiDashboardPluginIn": { - "description": "JSON:API representation of dashboardPlugin entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "url": "" - }, - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiAutomationResultOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiAutomationResultOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiAutomationResultToManyLinkage" : { + "description" : "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items" : { + "$ref" : "#/components/schemas/JsonApiAutomationResultLinkage" + }, + "type" : "array" + }, + "JsonApiAutomationToOneLinkage" : { + "description" : "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiAutomationLinkage" + } ] + }, + "JsonApiColorPaletteIn" : { + "description" : "JSON:API representation of colorPalette entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { }, + "type" : "object" }, - "title": { - "maxLength": 255, - "type": "string" + "name" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "required" : [ "content", "name" ], + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "type": { - "description": "Object type", - "enum": [ - "dashboardPlugin" - ], - "example": "dashboardPlugin", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "colorPalette" ], + "example" : "colorPalette", + "type" : "string" } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiDashboardPluginInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDashboardPluginIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiDashboardPluginLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "dashboardPlugin" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiDashboardPluginOut": { - "description": "JSON:API representation of dashboardPlugin entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "url": "" - }, - "type": "object" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "modifiedAt": { - "format": "date-time", - "type": "string" + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiColorPaletteInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiColorPaletteIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiColorPaletteOut" : { + "description" : "JSON:API representation of colorPalette entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { }, + "type" : "object" }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" - }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" - } - }, - "required": [ - "originId", - "originType" - ], - "type": "object" + "name" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "required" : [ "content", "name" ], + "type" : "object" }, - "relationships": { - "properties": { - "createdBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "modifiedBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "type": { - "description": "Object type", - "enum": [ - "dashboardPlugin" - ], - "example": "dashboardPlugin", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "colorPalette" ], + "example" : "colorPalette", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiDashboardPluginOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOut" - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" - }, - "type": "array", - "uniqueItems": true + "JsonApiColorPaletteOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiColorPaletteOut" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiDashboardPluginOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + "JsonApiColorPaletteOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiColorPaletteOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiColorPaletteOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiColorPaletteOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] }, - "JsonApiDashboardPluginOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiDashboardPluginOut" + "JsonApiColorPalettePatch" : { + "description" : "JSON:API representation of patching colorPalette entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { }, + "type" : "object" + }, + "name" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" + "type" : { + "description" : "Object type", + "enum" : [ "colorPalette" ], + "example" : "colorPalette", + "type" : "string" } - ] + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiDashboardPluginPatch": { - "description": "JSON:API representation of patching dashboardPlugin entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "url": "" - }, - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" + "JsonApiColorPalettePatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiColorPalettePatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiCookieSecurityConfigurationIn" : { + "description" : "JSON:API representation of cookieSecurityConfiguration entity.", + "properties" : { + "attributes" : { + "properties" : { + "lastRotation" : { + "format" : "date-time", + "type" : "string" }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" + "rotationInterval" : { + "description" : "Length of interval between automatic rotations expressed in format of ISO 8601 duration", + "example" : "P30D", + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "cookieSecurityConfiguration" ], + "example" : "cookieSecurityConfiguration", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiCookieSecurityConfigurationInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiCookieSecurityConfigurationIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiCookieSecurityConfigurationOut" : { + "description" : "JSON:API representation of cookieSecurityConfiguration entity.", + "properties" : { + "attributes" : { + "properties" : { + "lastRotation" : { + "format" : "date-time", + "type" : "string" }, - "title": { - "maxLength": 255, - "type": "string" + "rotationInterval" : { + "description" : "Length of interval between automatic rotations expressed in format of ISO 8601 duration", + "example" : "P30D", + "type" : "string" } }, - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "type": { - "description": "Object type", - "enum": [ - "dashboardPlugin" - ], - "example": "dashboardPlugin", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "cookieSecurityConfiguration" ], + "example" : "cookieSecurityConfiguration", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiDashboardPluginPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiDashboardPluginPostOptionalId": { - "description": "JSON:API representation of dashboardPlugin entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "url": "" - }, - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "dashboardPlugin" - ], - "example": "dashboardPlugin", - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "JsonApiDashboardPluginPostOptionalIdDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalId" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiDashboardPluginToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiDashboardPluginLinkage" - }, - "type": "array" - }, - "JsonApiDataSourceIdentifierOut": { - "description": "JSON:API representation of dataSourceIdentifier entity.", - "properties": { - "attributes": { - "properties": { - "name": { - "maxLength": 255, - "type": "string" - }, - "schema": { - "maxLength": 255, - "type": "string" - }, - "type": { - "enum": [ - "POSTGRESQL", - "REDSHIFT", - "VERTICA", - "SNOWFLAKE", - "ADS", - "BIGQUERY", - "MSSQL", - "PRESTO", - "DREMIO", - "DRILL", - "GREENPLUM", - "AZURESQL", - "SYNAPSESQL", - "DATABRICKS", - "GDSTORAGE", - "CLICKHOUSE", - "MYSQL", - "MARIADB", - "ORACLE", - "PINOT", - "SINGLESTORE", - "MOTHERDUCK", - "FLEXCONNECT", - "STARROCKS", - "ATHENA", - "MONGODB", - "CRATEDB" - ], - "type": "string" - } - }, - "required": [ - "name", - "schema", - "type" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "permissions": { - "description": "List of valid permissions for a logged-in user.", - "items": { - "enum": [ - "MANAGE", - "USE" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "dataSourceIdentifier" - ], - "example": "dataSourceIdentifier", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiDataSourceIdentifierOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiDataSourceIdentifierOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiDataSourceIdentifierOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiDataSourceIn": { - "description": "JSON:API representation of dataSource entity.", - "properties": { - "attributes": { - "properties": { - "alternativeDataSourceId": { - "description": "Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.", - "example": "pg_local_docker-demo2", - "nullable": true, - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "cacheStrategy": { - "description": "Determines how the results coming from a particular datasource should be cached.", - "enum": [ - "ALWAYS", - "NEVER" - ], - "nullable": true, - "type": "string" - }, - "clientId": { - "description": "The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "clientSecret": { - "description": "The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "name": { - "description": "User-facing name of the data source.", - "maxLength": 255, - "type": "string" - }, - "parameters": { - "description": "Additional parameters to be used when connecting to the database providing the data for the data source.", - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "password": { - "description": "The password to use to connect to the database providing the data for the data source.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "privateKey": { - "description": "The private key to use to connect to the database providing the data for the data source.", - "maxLength": 15000, - "nullable": true, - "type": "string" - }, - "privateKeyPassphrase": { - "description": "The passphrase used to encrypt the private key.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "schema": { - "description": "The schema to use as the root of the data for the data source.", - "maxLength": 255, - "type": "string" - }, - "token": { - "description": "The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account).", - "maxLength": 10000, - "nullable": true, - "type": "string" - }, - "type": { - "description": "Type of the database providing the data for the data source.", - "enum": [ - "POSTGRESQL", - "REDSHIFT", - "VERTICA", - "SNOWFLAKE", - "ADS", - "BIGQUERY", - "MSSQL", - "PRESTO", - "DREMIO", - "DRILL", - "GREENPLUM", - "AZURESQL", - "SYNAPSESQL", - "DATABRICKS", - "GDSTORAGE", - "CLICKHOUSE", - "MYSQL", - "MARIADB", - "ORACLE", - "PINOT", - "SINGLESTORE", - "MOTHERDUCK", - "FLEXCONNECT", - "STARROCKS", - "ATHENA", - "MONGODB", - "CRATEDB" - ], - "type": "string" - }, - "url": { - "description": "The URL of the database providing the data for the data source.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "username": { - "description": "The username to use to connect to the database providing the data for the data source.", - "maxLength": 255, - "nullable": true, - "type": "string" - } - }, - "required": [ - "name", - "schema", - "type" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "dataSource" - ], - "example": "dataSource", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiDataSourceInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDataSourceIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiDataSourceOut": { - "description": "JSON:API representation of dataSource entity.", - "properties": { - "attributes": { - "properties": { - "alternativeDataSourceId": { - "description": "Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.", - "example": "pg_local_docker-demo2", - "nullable": true, - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "authenticationType": { - "description": "Type of authentication used to connect to the database.", - "enum": [ - "USERNAME_PASSWORD", - "TOKEN", - "KEY_PAIR", - "CLIENT_SECRET", - "ACCESS_TOKEN" - ], - "nullable": true, - "type": "string" - }, - "cacheStrategy": { - "description": "Determines how the results coming from a particular datasource should be cached.", - "enum": [ - "ALWAYS", - "NEVER" - ], - "nullable": true, - "type": "string" - }, - "clientId": { - "description": "The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "decodedParameters": { - "description": "Decoded parameters to be used when connecting to the database providing the data for the data source.", - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "name": { - "description": "User-facing name of the data source.", - "maxLength": 255, - "type": "string" - }, - "parameters": { - "description": "Additional parameters to be used when connecting to the database providing the data for the data source.", - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "schema": { - "description": "The schema to use as the root of the data for the data source.", - "maxLength": 255, - "type": "string" - }, - "type": { - "description": "Type of the database providing the data for the data source.", - "enum": [ - "POSTGRESQL", - "REDSHIFT", - "VERTICA", - "SNOWFLAKE", - "ADS", - "BIGQUERY", - "MSSQL", - "PRESTO", - "DREMIO", - "DRILL", - "GREENPLUM", - "AZURESQL", - "SYNAPSESQL", - "DATABRICKS", - "GDSTORAGE", - "CLICKHOUSE", - "MYSQL", - "MARIADB", - "ORACLE", - "PINOT", - "SINGLESTORE", - "MOTHERDUCK", - "FLEXCONNECT", - "STARROCKS", - "ATHENA", - "MONGODB", - "CRATEDB" - ], - "type": "string" - }, - "url": { - "description": "The URL of the database providing the data for the data source.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "username": { - "description": "The username to use to connect to the database providing the data for the data source.", - "maxLength": 255, - "nullable": true, - "type": "string" - } - }, - "required": [ - "name", - "schema", - "type" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "permissions": { - "description": "List of valid permissions for a logged-in user.", - "items": { - "enum": [ - "MANAGE", - "USE" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "dataSource" - ], - "example": "dataSource", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiDataSourceOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDataSourceOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiDataSourceOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiDataSourceOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiDataSourceOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiDataSourceOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiDataSourcePatch": { - "description": "JSON:API representation of patching dataSource entity.", - "properties": { - "attributes": { - "properties": { - "alternativeDataSourceId": { - "description": "Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.", - "example": "pg_local_docker-demo2", - "nullable": true, - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "cacheStrategy": { - "description": "Determines how the results coming from a particular datasource should be cached.", - "enum": [ - "ALWAYS", - "NEVER" - ], - "nullable": true, - "type": "string" - }, - "clientId": { - "description": "The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "clientSecret": { - "description": "The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "name": { - "description": "User-facing name of the data source.", - "maxLength": 255, - "type": "string" - }, - "parameters": { - "description": "Additional parameters to be used when connecting to the database providing the data for the data source.", - "items": { - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "name", - "value" - ], - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "password": { - "description": "The password to use to connect to the database providing the data for the data source.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "privateKey": { - "description": "The private key to use to connect to the database providing the data for the data source.", - "maxLength": 15000, - "nullable": true, - "type": "string" - }, - "privateKeyPassphrase": { - "description": "The passphrase used to encrypt the private key.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "schema": { - "description": "The schema to use as the root of the data for the data source.", - "maxLength": 255, - "type": "string" - }, - "token": { - "description": "The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account).", - "maxLength": 10000, - "nullable": true, - "type": "string" - }, - "type": { - "description": "Type of the database providing the data for the data source.", - "enum": [ - "POSTGRESQL", - "REDSHIFT", - "VERTICA", - "SNOWFLAKE", - "ADS", - "BIGQUERY", - "MSSQL", - "PRESTO", - "DREMIO", - "DRILL", - "GREENPLUM", - "AZURESQL", - "SYNAPSESQL", - "DATABRICKS", - "GDSTORAGE", - "CLICKHOUSE", - "MYSQL", - "MARIADB", - "ORACLE", - "PINOT", - "SINGLESTORE", - "MOTHERDUCK", - "FLEXCONNECT", - "STARROCKS", - "ATHENA", - "MONGODB", - "CRATEDB" - ], - "type": "string" - }, - "url": { - "description": "The URL of the database providing the data for the data source.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "username": { - "description": "The username to use to connect to the database providing the data for the data source.", - "maxLength": 255, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "dataSource" - ], - "example": "dataSource", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiDataSourcePatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDataSourcePatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiDatasetLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "dataset" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiDatasetOut": { - "description": "JSON:API representation of dataset entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "dataSourceTableId": { - "maxLength": 255, - "type": "string" - }, - "dataSourceTablePath": { - "description": "Path to database table.", - "example": [ - "schema", - "table" - ], - "items": { - "maxLength": 255, - "type": "string" - }, - "type": "array" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "grain": { - "items": { - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "attribute", - "date" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "type": "array" - }, - "precedence": { - "format": "int32", - "type": "integer" - }, - "referenceProperties": { - "items": { - "properties": { - "identifier": { - "$ref": "#/components/schemas/DatasetReferenceIdentifier" - }, - "multivalue": { - "type": "boolean" - }, - "sourceColumnDataTypes": { - "items": { - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "type": "string" - }, - "type": "array" - }, - "sourceColumns": { - "items": { - "type": "string" - }, - "type": "array" - }, - "sources": { - "items": { - "$ref": "#/components/schemas/ReferenceSourceColumn" - }, - "type": "array" - } - }, - "required": [ - "identifier", - "multivalue" - ], - "type": "object" - }, - "type": "array" - }, - "sql": { - "properties": { - "dataSourceId": { - "type": "string" - }, - "statement": { - "type": "string" - } - }, - "required": [ - "dataSourceId", - "statement" - ], - "type": "object" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - }, - "type": { - "enum": [ - "NORMAL", - "DATE" - ], - "type": "string" - }, - "workspaceDataFilterColumns": { - "items": { - "properties": { - "dataType": { - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "dataType", - "name" - ], - "type": "object" - }, - "type": "array" - }, - "workspaceDataFilterReferences": { - "items": { - "description": "Workspace data filter reference.", - "properties": { - "filterColumn": { - "type": "string" - }, - "filterColumnDataType": { - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "type": "string" - }, - "filterId": { - "$ref": "#/components/schemas/DatasetWorkspaceDataFilterIdentifier" - } - }, - "required": [ - "filterColumn", - "filterColumnDataType", - "filterId" - ], - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" - }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" - } - }, - "required": [ - "originId", - "originType" - ], - "type": "object" - } - }, - "type": "object" + "JsonApiCookieSecurityConfigurationOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiCookieSecurityConfigurationOut" }, - "relationships": { - "properties": { - "aggregatedFacts": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAggregatedFactToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "attributes": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "facts": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFactToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "references": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiCookieSecurityConfigurationPatch" : { + "description" : "JSON:API representation of patching cookieSecurityConfiguration entity.", + "properties" : { + "attributes" : { + "properties" : { + "lastRotation" : { + "format" : "date-time", + "type" : "string" }, - "workspaceDataFilters": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "rotationInterval" : { + "description" : "Length of interval between automatic rotations expressed in format of ISO 8601 duration", + "example" : "P30D", + "type" : "string" } }, - "type": "object" + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "type": { - "description": "Object type", - "enum": [ - "dataset" - ], - "example": "dataset", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "cookieSecurityConfiguration" ], + "example" : "cookieSecurityConfiguration", + "type" : "string" } }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiDatasetOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDatasetOut" - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiDatasetOutIncludes" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "JsonApiCookieSecurityConfigurationPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiCookieSecurityConfigurationPatch" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiDatasetOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" + "JsonApiCspDirectiveIn" : { + "description" : "JSON:API representation of cspDirective entity.", + "properties" : { + "attributes" : { + "properties" : { + "sources" : { + "items" : { + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ "sources" ], + "type" : "object" }, - { - "$ref": "#/components/schemas/JsonApiFactOutWithLinks" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutWithLinks" + "type" : { + "description" : "Object type", + "enum" : [ "cspDirective" ], + "example" : "cspDirective", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiCspDirectiveInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiCspDirectiveIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiCspDirectiveOut" : { + "description" : "JSON:API representation of cspDirective entity.", + "properties" : { + "attributes" : { + "properties" : { + "sources" : { + "items" : { + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ "sources" ], + "type" : "object" }, - { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + "type" : { + "description" : "Object type", + "enum" : [ "cspDirective" ], + "example" : "cspDirective", + "type" : "string" } - ] + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiDatasetOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" - }, - "type": "array", - "uniqueItems": true + "JsonApiCspDirectiveOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiCspDirectiveOut" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiDatasetOutIncludes" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiCspDirectiveOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiCspDirectiveOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiDatasetOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiDatasetOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "JsonApiCspDirectiveOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiCspDirectiveOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] }, - "JsonApiDatasetPatch": { - "description": "JSON:API representation of patching dataset entity.", - "properties": { - "attributes": { - "properties": { - "description": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" + "JsonApiCspDirectivePatch" : { + "description" : "JSON:API representation of patching cspDirective entity.", + "properties" : { + "attributes" : { + "properties" : { + "sources" : { + "items" : { + "type" : "string" }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" + "type" : "array" } }, - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "type": { - "description": "Object type", - "enum": [ - "dataset" - ], - "example": "dataset", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "cspDirective" ], + "example" : "cspDirective", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiDatasetPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDatasetPatch" + "JsonApiCspDirectivePatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiCspDirectivePatch" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiDatasetToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiDatasetLinkage" - }, - "type": "array" - }, - "JsonApiDatasetToOneLinkage": { - "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "nullable": true, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiDatasetLinkage" - } - ] - }, - "JsonApiEntitlementOut": { - "description": "JSON:API representation of entitlement entity.", - "properties": { - "attributes": { - "properties": { - "expiry": { - "format": "date", - "type": "string" + "JsonApiCustomApplicationSettingIn" : { + "description" : "JSON:API representation of customApplicationSetting entity.", + "properties" : { + "attributes" : { + "properties" : { + "applicationName" : { + "maxLength" : 255, + "type" : "string" }, - "value": { - "maxLength": 255, - "type": "string" + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { }, + "type" : "object" } }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "entitlement" - ], - "example": "entitlement", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiEntitlementOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiEntitlementOut" + "required" : [ "applicationName", "content" ], + "type" : "object" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiEntitlementOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiEntitlementOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" + "type" : { + "description" : "Object type", + "enum" : [ "customApplicationSetting" ], + "example" : "customApplicationSetting", + "type" : "string" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiEntitlementOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiEntitlementOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "JsonApiCustomApplicationSettingInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingIn" + } + }, + "required" : [ "data" ], + "type" : "object" }, - "JsonApiExportDefinitionIn": { - "description": "JSON:API representation of exportDefinition entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "requestPayload": { - "description": "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", - "oneOf": [ - { - "$ref": "#/components/schemas/VisualExportRequest" + "JsonApiCustomApplicationSettingOut" : { + "description" : "JSON:API representation of customApplicationSetting entity.", + "properties" : { + "attributes" : { + "properties" : { + "applicationName" : { + "maxLength" : 255, + "type" : "string" + }, + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { }, + "type" : "object" + } + }, + "required" : [ "applicationName", "content" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" }, - { - "$ref": "#/components/schemas/TabularExportRequest" + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" } - ], - "type": "object" - }, - "tags": { - "items": { - "type": "string" }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" + "required" : [ "originId", "originType" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "customApplicationSetting" ], + "example" : "customApplicationSetting", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiCustomApplicationSettingOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingOut" }, - "relationships": { - "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "visualizationObject": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "exportDefinition" - ], - "example": "exportDefinition", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiExportDefinitionInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiExportDefinitionIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiExportDefinitionLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "exportDefinition" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiExportDefinitionOut": { - "description": "JSON:API representation of exportDefinition entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "modifiedAt": { - "format": "date-time", - "type": "string" - }, - "requestPayload": { - "description": "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", - "oneOf": [ - { - "$ref": "#/components/schemas/VisualExportRequest" - }, - { - "$ref": "#/components/schemas/TabularExportRequest" - } - ], - "type": "object" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiCustomApplicationSettingOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingOutWithLinks" }, - "type": "object" + "type" : "array", + "uniqueItems" : true }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" - }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" - } - }, - "required": [ - "originId", - "originType" - ], - "type": "object" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" - }, - "relationships": { - "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "automation": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAutomationToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "createdBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "modifiedBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "type" : "object" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiCustomApplicationSettingOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiCustomApplicationSettingPatch" : { + "description" : "JSON:API representation of patching customApplicationSetting entity.", + "properties" : { + "attributes" : { + "properties" : { + "applicationName" : { + "maxLength" : 255, + "type" : "string" }, - "visualizationObject": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { }, + "type" : "object" } }, - "type": "object" + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "type": { - "description": "Object type", - "enum": [ - "exportDefinition" - ], - "example": "exportDefinition", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "customApplicationSetting" ], + "example" : "customApplicationSetting", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiExportDefinitionOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOut" - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutIncludes" + "JsonApiCustomApplicationSettingPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingPatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiCustomApplicationSettingPostOptionalId" : { + "description" : "JSON:API representation of customApplicationSetting entity.", + "properties" : { + "attributes" : { + "properties" : { + "applicationName" : { + "maxLength" : 255, + "type" : "string" + }, + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { }, + "type" : "object" + } }, - "type": "array", - "uniqueItems": true + "required" : [ "applicationName", "content" ], + "type" : "object" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "customApplicationSetting" ], + "example" : "customApplicationSetting", + "type" : "string" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "attributes", "type" ], + "type" : "object" }, - "JsonApiExportDefinitionOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" + "JsonApiCustomApplicationSettingPostOptionalIdDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalId" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiCustomGeoCollectionIn" : { + "description" : "JSON:API representation of customGeoCollection entity.", + "properties" : { + "attributes" : { + "properties" : { + "description" : { + "maxLength" : 10000, + "nullable" : true, + "type" : "string" + }, + "name" : { + "maxLength" : 255, + "nullable" : true, + "type" : "string" + } + }, + "type" : "object" }, - { - "$ref": "#/components/schemas/JsonApiAutomationOutWithLinks" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + "type" : { + "description" : "Object type", + "enum" : [ "customGeoCollection" ], + "example" : "customGeoCollection", + "type" : "string" } - ] + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiCustomGeoCollectionInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionIn" + } + }, + "required" : [ "data" ], + "type" : "object" }, - "JsonApiExportDefinitionOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutWithLinks" + "JsonApiCustomGeoCollectionOut" : { + "description" : "JSON:API representation of customGeoCollection entity.", + "properties" : { + "attributes" : { + "properties" : { + "description" : { + "maxLength" : 10000, + "nullable" : true, + "type" : "string" + }, + "name" : { + "maxLength" : 255, + "nullable" : true, + "type" : "string" + } }, - "type": "array", - "uniqueItems": true + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "customGeoCollection" ], + "example" : "customGeoCollection", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiCustomGeoCollectionOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionOut" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutIncludes" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiCustomGeoCollectionOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiExportDefinitionOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiExportDefinitionOut" + "JsonApiCustomGeoCollectionOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiCustomGeoCollectionPatch" : { + "description" : "JSON:API representation of patching customGeoCollection entity.", + "properties" : { + "attributes" : { + "properties" : { + "description" : { + "maxLength" : 10000, + "nullable" : true, + "type" : "string" + }, + "name" : { + "maxLength" : 255, + "nullable" : true, + "type" : "string" + } + }, + "type" : "object" }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "customGeoCollection" ], + "example" : "customGeoCollection", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiCustomGeoCollectionPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionPatch" } - ] + }, + "required" : [ "data" ], + "type" : "object" }, - "JsonApiExportDefinitionPatch": { - "description": "JSON:API representation of patching exportDefinition entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" + "JsonApiDashboardPluginIn" : { + "description" : "JSON:API representation of dashboardPlugin entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" }, - "description": { - "maxLength": 10000, - "type": "string" + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { + "url" : "" + }, + "type" : "object" }, - "requestPayload": { - "description": "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", - "oneOf": [ - { - "$ref": "#/components/schemas/VisualExportRequest" - }, - { - "$ref": "#/components/schemas/TabularExportRequest" - } - ], - "type": "object" + "description" : { + "maxLength" : 10000, + "type" : "string" }, - "tags": { - "items": { - "type": "string" + "tags" : { + "items" : { + "type" : "string" }, - "type": "array" + "type" : "array" }, - "title": { - "maxLength": 255, - "type": "string" + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "relationships": { - "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "type" : { + "description" : "Object type", + "enum" : [ "dashboardPlugin" ], + "example" : "dashboardPlugin", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiDashboardPluginInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiDashboardPluginLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "dashboardPlugin" ], + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiDashboardPluginOut" : { + "description" : "JSON:API representation of dashboardPlugin entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" }, - "visualizationObject": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" - } + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { + "url" : "" }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "exportDefinition" - ], - "example": "exportDefinition", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiExportDefinitionPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiExportDefinitionPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiExportDefinitionPostOptionalId": { - "description": "JSON:API representation of exportDefinition entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "requestPayload": { - "description": "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", - "oneOf": [ - { - "$ref": "#/components/schemas/VisualExportRequest" - }, - { - "$ref": "#/components/schemas/TabularExportRequest" - } - ], - "type": "object" + "type" : "object" + }, + "createdAt" : { + "description" : "Time of the entity creation.", + "format" : "date-time", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "modifiedAt" : { + "description" : "Time of the last entity modification.", + "format" : "date-time", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" }, - "tags": { - "items": { - "type": "string" + "tags" : { + "items" : { + "type" : "string" }, - "type": "array" + "type" : "array" }, - "title": { - "maxLength": 255, - "type": "string" + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "relationships": { - "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "visualizationObject": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "exportDefinition" - ], - "example": "exportDefinition", - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "JsonApiExportDefinitionPostOptionalIdDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiExportDefinitionPostOptionalId" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiExportDefinitionToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiExportDefinitionLinkage" - }, - "type": "array" - }, - "JsonApiExportTemplateIn": { - "description": "JSON:API representation of exportTemplate entity.", - "properties": { - "attributes": { - "properties": { - "dashboardSlidesTemplate": { - "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", - "nullable": true, - "properties": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], - "items": { - "enum": [ - "PDF", - "PPTX" - ], - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "contentSlide": { - "$ref": "#/components/schemas/ContentSlideTemplate" - }, - "coverSlide": { - "$ref": "#/components/schemas/CoverSlideTemplate" - }, - "introSlide": { - "$ref": "#/components/schemas/IntroSlideTemplate" - }, - "sectionSlide": { - "$ref": "#/components/schemas/SectionSlideTemplate" - } - }, - "required": [ - "appliedOn" - ], - "type": "object" - }, - "name": { - "description": "User-facing name of the Slides template.", - "maxLength": 255, - "type": "string" - }, - "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, - "properties": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], - "items": { - "enum": [ - "PDF", - "PPTX" - ], - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "contentSlide": { - "$ref": "#/components/schemas/ContentSlideTemplate" - } - }, - "required": [ - "appliedOn" - ], - "type": "object" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "exportTemplate" - ], - "example": "exportTemplate", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiExportTemplateInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiExportTemplateIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiExportTemplateOut": { - "description": "JSON:API representation of exportTemplate entity.", - "properties": { - "attributes": { - "properties": { - "dashboardSlidesTemplate": { - "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", - "nullable": true, - "properties": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], - "items": { - "enum": [ - "PDF", - "PPTX" - ], - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "contentSlide": { - "$ref": "#/components/schemas/ContentSlideTemplate" - }, - "coverSlide": { - "$ref": "#/components/schemas/CoverSlideTemplate" - }, - "introSlide": { - "$ref": "#/components/schemas/IntroSlideTemplate" - }, - "sectionSlide": { - "$ref": "#/components/schemas/SectionSlideTemplate" - } - }, - "required": [ - "appliedOn" - ], - "type": "object" - }, - "name": { - "description": "User-facing name of the Slides template.", - "maxLength": 255, - "type": "string" - }, - "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, - "properties": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], - "items": { - "enum": [ - "PDF", - "PPTX" - ], - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "contentSlide": { - "$ref": "#/components/schemas/ContentSlideTemplate" - } - }, - "required": [ - "appliedOn" - ], - "type": "object" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "exportTemplate" - ], - "example": "exportTemplate", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiExportTemplateOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiExportTemplateOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiExportTemplateOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiExportTemplateOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiExportTemplateOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiExportTemplatePatch": { - "description": "JSON:API representation of patching exportTemplate entity.", - "properties": { - "attributes": { - "properties": { - "dashboardSlidesTemplate": { - "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", - "nullable": true, - "properties": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], - "items": { - "enum": [ - "PDF", - "PPTX" - ], - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "contentSlide": { - "$ref": "#/components/schemas/ContentSlideTemplate" - }, - "coverSlide": { - "$ref": "#/components/schemas/CoverSlideTemplate" - }, - "introSlide": { - "$ref": "#/components/schemas/IntroSlideTemplate" - }, - "sectionSlide": { - "$ref": "#/components/schemas/SectionSlideTemplate" - } - }, - "required": [ - "appliedOn" - ], - "type": "object" - }, - "name": { - "description": "User-facing name of the Slides template.", - "maxLength": 255, - "type": "string" - }, - "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, - "properties": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], - "items": { - "enum": [ - "PDF", - "PPTX" - ], - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "contentSlide": { - "$ref": "#/components/schemas/ContentSlideTemplate" - } - }, - "required": [ - "appliedOn" - ], - "type": "object" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "exportTemplate" - ], - "example": "exportTemplate", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiExportTemplatePatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiExportTemplatePatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiExportTemplatePostOptionalId": { - "description": "JSON:API representation of exportTemplate entity.", - "properties": { - "attributes": { - "properties": { - "dashboardSlidesTemplate": { - "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", - "nullable": true, - "properties": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], - "items": { - "enum": [ - "PDF", - "PPTX" - ], - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "contentSlide": { - "$ref": "#/components/schemas/ContentSlideTemplate" - }, - "coverSlide": { - "$ref": "#/components/schemas/CoverSlideTemplate" - }, - "introSlide": { - "$ref": "#/components/schemas/IntroSlideTemplate" - }, - "sectionSlide": { - "$ref": "#/components/schemas/SectionSlideTemplate" - } - }, - "required": [ - "appliedOn" - ], - "type": "object" - }, - "name": { - "description": "User-facing name of the Slides template.", - "maxLength": 255, - "type": "string" - }, - "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, - "properties": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], - "items": { - "enum": [ - "PDF", - "PPTX" - ], - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "contentSlide": { - "$ref": "#/components/schemas/ContentSlideTemplate" - } - }, - "required": [ - "appliedOn" - ], - "type": "object" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "exportTemplate" - ], - "example": "exportTemplate", - "type": "string" - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - }, - "JsonApiExportTemplatePostOptionalIdDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalId" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiFactLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "fact" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiFactOut": { - "description": "JSON:API representation of fact entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "isHidden": { - "type": "boolean" - }, - "isNullable": { - "type": "boolean" - }, - "nullValue": { - "type": "string" - }, - "sourceColumn": { - "maxLength": 255, - "type": "string" - }, - "sourceColumnDataType": { - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" } }, - "required": [ - "originId", - "originType" - ], - "type": "object" + "required" : [ "originId", "originType" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "relationships": { - "properties": { - "dataset": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDatasetToOneLinkage" + "relationships" : { + "properties" : { + "createdBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "modifiedBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "fact" - ], - "example": "fact", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "dashboardPlugin" ], + "example" : "dashboardPlugin", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiFactOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFactOut" + "JsonApiDashboardPluginOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginOut" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiFactOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiFactOutWithLinks" + "JsonApiDashboardPluginOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiFactOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiFactOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "JsonApiDashboardPluginOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiDashboardPluginOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] }, - "JsonApiFactPatch": { - "description": "JSON:API representation of patching fact entity.", - "properties": { - "attributes": { - "properties": { - "description": { - "maxLength": 10000, - "type": "string" + "JsonApiDashboardPluginPatch" : { + "description" : "JSON:API representation of patching dashboardPlugin entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { + "url" : "" + }, + "type" : "object" }, - "tags": { - "items": { - "type": "string" + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" }, - "type": "array" + "type" : "array" }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "fact" - ], - "example": "fact", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "dashboardPlugin" ], + "example" : "dashboardPlugin", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiFactPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFactPatch" + "JsonApiDashboardPluginPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginPatch" } }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiFactToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiFactLinkage" - }, - "type": "array" - }, - "JsonApiFactToOneLinkage": { - "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "nullable": true, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiFactLinkage" - } - ] + "required" : [ "data" ], + "type" : "object" }, - "JsonApiFilterContextIn": { - "description": "JSON:API representation of filterContext entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" + "JsonApiDashboardPluginPostOptionalId" : { + "description" : "JSON:API representation of dashboardPlugin entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - }, - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "filterContext" - ], - "example": "filterContext", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiFilterContextInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFilterContextIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiFilterContextLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "filterContext" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiFilterContextOut": { - "description": "JSON:API representation of filterContext entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { + "url" : "" }, - "type": "object" + "type" : "object" }, - "description": { - "maxLength": 10000, - "type": "string" + "description" : { + "maxLength" : 10000, + "type" : "string" }, - "tags": { - "items": { - "type": "string" + "tags" : { + "items" : { + "type" : "string" }, - "type": "array" + "type" : "array" }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" - }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" - } - }, - "required": [ - "originId", - "originType" - ], - "type": "object" + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "type" : "object" }, - "relationships": { - "properties": { - "attributes": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "datasets": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "labels": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "type": { - "description": "Object type", - "enum": [ - "filterContext" - ], - "example": "filterContext", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "dashboardPlugin" ], + "example" : "dashboardPlugin", + "type" : "string" } }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" + "required" : [ "type" ], + "type" : "object" }, - "JsonApiFilterContextOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFilterContextOut" - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiFilterContextOutIncludes" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "JsonApiDashboardPluginPostOptionalIdDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginPostOptionalId" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiFilterContextOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" - } - ] + "JsonApiDashboardPluginToManyLinkage" : { + "description" : "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginLinkage" + }, + "type" : "array" }, - "JsonApiFilterContextOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiFilterContextOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiFilterContextOutIncludes" + "JsonApiDataSourceIdentifierOut" : { + "description" : "JSON:API representation of dataSourceIdentifier entity.", + "properties" : { + "attributes" : { + "properties" : { + "name" : { + "maxLength" : 255, + "type" : "string" + }, + "schema" : { + "maxLength" : 255, + "type" : "string" + }, + "type" : { + "enum" : [ "POSTGRESQL", "REDSHIFT", "VERTICA", "SNOWFLAKE", "ADS", "BIGQUERY", "MSSQL", "PRESTO", "DREMIO", "DRILL", "GREENPLUM", "AZURESQL", "SYNAPSESQL", "DATABRICKS", "GDSTORAGE", "CLICKHOUSE", "MYSQL", "MARIADB", "ORACLE", "PINOT", "SINGLESTORE", "MOTHERDUCK", "FLEXCONNECT", "STARROCKS", "ATHENA", "MONGODB", "CRATEDB", "AILAKEHOUSE" ], + "type" : "string" + } }, - "type": "array", - "uniqueItems": true + "required" : [ "name", "schema", "type" ], + "type" : "object" }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "permissions" : { + "description" : "List of valid permissions for a logged-in user.", + "items" : { + "enum" : [ "MANAGE", "USE" ], + "type" : "string" + }, + "type" : "array" } }, - "type": "object" + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "dataSourceIdentifier" ], + "example" : "dataSourceIdentifier", + "type" : "string" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiFilterContextOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiFilterContextOut" + "JsonApiDataSourceIdentifierOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDataSourceIdentifierOut" }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } - ] + }, + "required" : [ "data" ], + "type" : "object" }, - "JsonApiFilterContextPatch": { - "description": "JSON:API representation of patching filterContext entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" + "JsonApiDataSourceIdentifierOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiDataSourceIdentifierOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } + }, + "type" : "object" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiDataSourceIdentifierOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiDataSourceIdentifierOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiDataSourceIn" : { + "description" : "JSON:API representation of dataSource entity.", + "properties" : { + "attributes" : { + "properties" : { + "alternativeDataSourceId" : { + "description" : "Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.", + "example" : "pg_local_docker-demo2", + "nullable" : true, + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "cacheStrategy" : { + "description" : "Determines how the results coming from a particular datasource should be cached.", + "enum" : [ "ALWAYS", "NEVER" ], + "nullable" : true, + "type" : "string" + }, + "clientId" : { + "description" : "The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "clientSecret" : { + "description" : "The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "name" : { + "description" : "User-facing name of the data source.", + "maxLength" : 255, + "type" : "string" + }, + "parameters" : { + "description" : "Additional parameters to be used when connecting to the database providing the data for the data source.", + "items" : { + "properties" : { + "name" : { + "type" : "string" + }, + "value" : { + "type" : "string" + } + }, + "required" : [ "name", "value" ], + "type" : "object" + }, + "nullable" : true, + "type" : "array" + }, + "password" : { + "description" : "The password to use to connect to the database providing the data for the data source.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "privateKey" : { + "description" : "The private key to use to connect to the database providing the data for the data source.", + "maxLength" : 15000, + "nullable" : true, + "type" : "string" + }, + "privateKeyPassphrase" : { + "description" : "The passphrase used to encrypt the private key.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "schema" : { + "description" : "The schema to use as the root of the data for the data source.", + "maxLength" : 255, + "type" : "string" + }, + "token" : { + "description" : "The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account).", + "maxLength" : 10000, + "nullable" : true, + "type" : "string" + }, + "type" : { + "description" : "Type of the database providing the data for the data source.", + "enum" : [ "POSTGRESQL", "REDSHIFT", "VERTICA", "SNOWFLAKE", "ADS", "BIGQUERY", "MSSQL", "PRESTO", "DREMIO", "DRILL", "GREENPLUM", "AZURESQL", "SYNAPSESQL", "DATABRICKS", "GDSTORAGE", "CLICKHOUSE", "MYSQL", "MARIADB", "ORACLE", "PINOT", "SINGLESTORE", "MOTHERDUCK", "FLEXCONNECT", "STARROCKS", "ATHENA", "MONGODB", "CRATEDB", "AILAKEHOUSE" ], + "type" : "string" + }, + "url" : { + "description" : "The URL of the database providing the data for the data source.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "username" : { + "description" : "The username to use to connect to the database providing the data for the data source.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + } + }, + "required" : [ "name", "schema", "type" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "dataSource" ], + "example" : "dataSource", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiDataSourceInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDataSourceIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiDataSourceOut" : { + "description" : "JSON:API representation of dataSource entity.", + "properties" : { + "attributes" : { + "properties" : { + "alternativeDataSourceId" : { + "description" : "Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.", + "example" : "pg_local_docker-demo2", + "nullable" : true, + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "authenticationType" : { + "description" : "Type of authentication used to connect to the database.", + "enum" : [ "USERNAME_PASSWORD", "TOKEN", "KEY_PAIR", "CLIENT_SECRET", "ACCESS_TOKEN" ], + "nullable" : true, + "type" : "string" + }, + "cacheStrategy" : { + "description" : "Determines how the results coming from a particular datasource should be cached.", + "enum" : [ "ALWAYS", "NEVER" ], + "nullable" : true, + "type" : "string" + }, + "clientId" : { + "description" : "The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "decodedParameters" : { + "description" : "Decoded parameters to be used when connecting to the database providing the data for the data source.", + "items" : { + "properties" : { + "name" : { + "type" : "string" + }, + "value" : { + "type" : "string" + } + }, + "required" : [ "name", "value" ], + "type" : "object" + }, + "nullable" : true, + "type" : "array" + }, + "name" : { + "description" : "User-facing name of the data source.", + "maxLength" : 255, + "type" : "string" + }, + "parameters" : { + "description" : "Additional parameters to be used when connecting to the database providing the data for the data source.", + "items" : { + "properties" : { + "name" : { + "type" : "string" + }, + "value" : { + "type" : "string" + } + }, + "required" : [ "name", "value" ], + "type" : "object" + }, + "nullable" : true, + "type" : "array" + }, + "schema" : { + "description" : "The schema to use as the root of the data for the data source.", + "maxLength" : 255, + "type" : "string" + }, + "type" : { + "description" : "Type of the database providing the data for the data source.", + "enum" : [ "POSTGRESQL", "REDSHIFT", "VERTICA", "SNOWFLAKE", "ADS", "BIGQUERY", "MSSQL", "PRESTO", "DREMIO", "DRILL", "GREENPLUM", "AZURESQL", "SYNAPSESQL", "DATABRICKS", "GDSTORAGE", "CLICKHOUSE", "MYSQL", "MARIADB", "ORACLE", "PINOT", "SINGLESTORE", "MOTHERDUCK", "FLEXCONNECT", "STARROCKS", "ATHENA", "MONGODB", "CRATEDB", "AILAKEHOUSE" ], + "type" : "string" + }, + "url" : { + "description" : "The URL of the database providing the data for the data source.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "username" : { + "description" : "The username to use to connect to the database providing the data for the data source.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + } + }, + "required" : [ "name", "schema", "type" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "meta" : { + "properties" : { + "permissions" : { + "description" : "List of valid permissions for a logged-in user.", + "items" : { + "enum" : [ "MANAGE", "USE" ], + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "dataSource" ], + "example" : "dataSource", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiDataSourceOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDataSourceOut" + }, + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiDataSourceOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiDataSourceOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } + }, + "type" : "object" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiDataSourceOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiDataSourceOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiDataSourcePatch" : { + "description" : "JSON:API representation of patching dataSource entity.", + "properties" : { + "attributes" : { + "properties" : { + "alternativeDataSourceId" : { + "description" : "Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.", + "example" : "pg_local_docker-demo2", + "nullable" : true, + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "cacheStrategy" : { + "description" : "Determines how the results coming from a particular datasource should be cached.", + "enum" : [ "ALWAYS", "NEVER" ], + "nullable" : true, + "type" : "string" + }, + "clientId" : { + "description" : "The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "clientSecret" : { + "description" : "The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "name" : { + "description" : "User-facing name of the data source.", + "maxLength" : 255, + "type" : "string" + }, + "parameters" : { + "description" : "Additional parameters to be used when connecting to the database providing the data for the data source.", + "items" : { + "properties" : { + "name" : { + "type" : "string" + }, + "value" : { + "type" : "string" + } + }, + "required" : [ "name", "value" ], + "type" : "object" + }, + "nullable" : true, + "type" : "array" + }, + "password" : { + "description" : "The password to use to connect to the database providing the data for the data source.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "privateKey" : { + "description" : "The private key to use to connect to the database providing the data for the data source.", + "maxLength" : 15000, + "nullable" : true, + "type" : "string" + }, + "privateKeyPassphrase" : { + "description" : "The passphrase used to encrypt the private key.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "schema" : { + "description" : "The schema to use as the root of the data for the data source.", + "maxLength" : 255, + "type" : "string" + }, + "token" : { + "description" : "The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account).", + "maxLength" : 10000, + "nullable" : true, + "type" : "string" + }, + "type" : { + "description" : "Type of the database providing the data for the data source.", + "enum" : [ "POSTGRESQL", "REDSHIFT", "VERTICA", "SNOWFLAKE", "ADS", "BIGQUERY", "MSSQL", "PRESTO", "DREMIO", "DRILL", "GREENPLUM", "AZURESQL", "SYNAPSESQL", "DATABRICKS", "GDSTORAGE", "CLICKHOUSE", "MYSQL", "MARIADB", "ORACLE", "PINOT", "SINGLESTORE", "MOTHERDUCK", "FLEXCONNECT", "STARROCKS", "ATHENA", "MONGODB", "CRATEDB", "AILAKEHOUSE" ], + "type" : "string" + }, + "url" : { + "description" : "The URL of the database providing the data for the data source.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "username" : { + "description" : "The username to use to connect to the database providing the data for the data source.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "dataSource" ], + "example" : "dataSource", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiDataSourcePatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDataSourcePatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiDatasetLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "dataset" ], + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiDatasetOut" : { + "description" : "JSON:API representation of dataset entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "dataSourceTableId" : { + "maxLength" : 255, + "type" : "string" + }, + "dataSourceTablePath" : { + "description" : "Path to database table.", + "example" : [ "schema", "table" ], + "items" : { + "maxLength" : 255, + "type" : "string" + }, + "type" : "array" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "grain" : { + "items" : { + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "attribute", "date" ], + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "type" : "array" + }, + "precedence" : { + "format" : "int32", + "type" : "integer" + }, + "referenceProperties" : { + "items" : { + "properties" : { + "identifier" : { + "$ref" : "#/components/schemas/DatasetReferenceIdentifier" + }, + "multivalue" : { + "type" : "boolean" + }, + "sourceColumnDataTypes" : { + "items" : { + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "type" : "string" + }, + "type" : "array" + }, + "sourceColumns" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "sources" : { + "items" : { + "$ref" : "#/components/schemas/ReferenceSourceColumn" + }, + "type" : "array" + } + }, + "required" : [ "identifier", "multivalue" ], + "type" : "object" + }, + "type" : "array" }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" + "sql" : { + "properties" : { + "dataSourceId" : { + "type" : "string" }, - "someBoolProp": false - }, - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "filterContext" - ], - "example": "filterContext", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiFilterContextPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFilterContextPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiFilterContextPostOptionalId": { - "description": "JSON:API representation of filterContext entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" + "statement" : { + "type" : "string" + } + }, + "required" : [ "dataSourceId", "statement" ], + "type" : "object" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + }, + "type" : { + "enum" : [ "NORMAL", "DATE" ], + "type" : "string" + }, + "workspaceDataFilterColumns" : { + "items" : { + "properties" : { + "dataType" : { + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "type" : "string" + }, + "name" : { + "type" : "string" + } }, - "someBoolProp": false + "required" : [ "dataType", "name" ], + "type" : "object" }, - "type": "object" + "type" : "array" }, - "description": { - "maxLength": 10000, - "type": "string" + "workspaceDataFilterReferences" : { + "items" : { + "description" : "Workspace data filter reference.", + "properties" : { + "filterColumn" : { + "type" : "string" + }, + "filterColumnDataType" : { + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "type" : "string" + }, + "filterId" : { + "$ref" : "#/components/schemas/DatasetWorkspaceDataFilterIdentifier" + } + }, + "required" : [ "filterColumn", "filterColumnDataType", "filterId" ], + "type" : "object" + }, + "type" : "array" + } + }, + "required" : [ "type" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" + }, + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" + } + }, + "required" : [ "originId", "originType" ], + "type" : "object" + } + }, + "type" : "object" + }, + "relationships" : { + "properties" : { + "aggregatedFacts" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAggregatedFactToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "filterContext" - ], - "example": "filterContext", - "type": "string" - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - }, - "JsonApiFilterContextPostOptionalIdDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFilterContextPostOptionalId" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiFilterContextToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiFilterContextLinkage" - }, - "type": "array" - }, - "JsonApiFilterViewIn": { - "description": "JSON:API representation of filterView entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "description": "The respective filter context.", - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "isDefault": { - "description": "Indicator whether the filter view should by applied by default.", - "type": "boolean" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content", - "title" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" + "attributes" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAttributeToManyLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "user": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" + "facts" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiFactToManyLinkage" } }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "filterView" - ], - "example": "filterView", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiFilterViewInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFilterViewIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiFilterViewOut": { - "description": "JSON:API representation of filterView entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "description": "The respective filter context.", - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "isDefault": { - "description": "Indicator whether the filter view should by applied by default.", - "type": "boolean" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content", - "title" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" + "required" : [ "data" ], + "type" : "object" + }, + "references" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDatasetToManyLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "user": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" + "workspaceDataFilters" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterToManyLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "filterView" - ], - "example": "filterView", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "dataset" ], + "example" : "dataset", + "type" : "string" } }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiFilterViewOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFilterViewOut" + "JsonApiDatasetOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDatasetOut" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiFilterViewOutIncludes" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiDatasetOutIncludes" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiFilterViewOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiUserOutWithLinks" - } - ] + "JsonApiDatasetOutIncludes" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiAttributeOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiFactOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiAggregatedFactOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiDatasetOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + } ] }, - "JsonApiFilterViewOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiFilterViewOutWithLinks" + "JsonApiDatasetOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiDatasetOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiFilterViewOutIncludes" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiDatasetOutIncludes" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiFilterViewOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiFilterViewOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "JsonApiDatasetOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiDatasetOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] }, - "JsonApiFilterViewPatch": { - "description": "JSON:API representation of patching filterView entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "description": "The respective filter context.", - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "isDefault": { - "description": "Indicator whether the filter view should by applied by default.", - "type": "boolean" + "JsonApiDatasetPatch" : { + "description" : "JSON:API representation of patching dataset entity.", + "properties" : { + "attributes" : { + "properties" : { + "description" : { + "maxLength" : 10000, + "type" : "string" }, - "tags": { - "items": { - "type": "string" + "tags" : { + "items" : { + "type" : "string" }, - "type": "array" + "type" : "array" }, - "title": { - "maxLength": 255, - "type": "string" + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "relationships": { - "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "type" : { + "description" : "Object type", + "enum" : [ "dataset" ], + "example" : "dataset", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiDatasetPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDatasetPatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiDatasetToManyLinkage" : { + "description" : "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items" : { + "$ref" : "#/components/schemas/JsonApiDatasetLinkage" + }, + "type" : "array" + }, + "JsonApiDatasetToOneLinkage" : { + "description" : "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiDatasetLinkage" + } ] + }, + "JsonApiEntitlementOut" : { + "description" : "JSON:API representation of entitlement entity.", + "properties" : { + "attributes" : { + "properties" : { + "expiry" : { + "format" : "date", + "type" : "string" }, - "user": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "filterView" - ], - "example": "filterView", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiFilterViewPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFilterViewPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiIdentityProviderIn": { - "description": "JSON:API representation of identityProvider entity.", - "properties": { - "attributes": { - "properties": { - "customClaimMapping": { - "additionalProperties": { - "type": "string" - }, - "description": "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", - "maxLength": 10000, - "type": "object" - }, - "identifiers": { - "description": "List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.", - "example": [ - "gooddata.com" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "idpType": { - "description": "Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", - "enum": [ - "MANAGED_IDP", - "FIM_IDP", - "DEX_IDP", - "CUSTOM_IDP" - ], - "type": "string" - }, - "oauthClientId": { - "description": "The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", - "maxLength": 255, - "type": "string" - }, - "oauthClientSecret": { - "description": "The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.", - "maxLength": 255, - "type": "string" - }, - "oauthCustomAuthAttributes": { - "additionalProperties": { - "type": "string" - }, - "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", - "maxLength": 10000, - "type": "object" - }, - "oauthCustomScopes": { - "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", - "items": { - "maxLength": 255, - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "oauthIssuerId": { - "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", - "example": "myOidcProvider", - "maxLength": 255, - "type": "string" - }, - "oauthIssuerLocation": { - "description": "The location of your OIDC provider. This field is mandatory for OIDC IdP.", - "maxLength": 255, - "type": "string" - }, - "oauthSubjectIdClaim": { - "description": "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", - "example": "oid", - "maxLength": 255, - "type": "string" - }, - "samlMetadata": { - "description": "Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.", - "maxLength": 15000, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "identityProvider" - ], - "example": "identityProvider", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiIdentityProviderInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiIdentityProviderIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiIdentityProviderLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "identityProvider" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiIdentityProviderOut": { - "description": "JSON:API representation of identityProvider entity.", - "properties": { - "attributes": { - "properties": { - "customClaimMapping": { - "additionalProperties": { - "type": "string" - }, - "description": "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", - "maxLength": 10000, - "type": "object" - }, - "identifiers": { - "description": "List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.", - "example": [ - "gooddata.com" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "idpType": { - "description": "Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", - "enum": [ - "MANAGED_IDP", - "FIM_IDP", - "DEX_IDP", - "CUSTOM_IDP" - ], - "type": "string" - }, - "oauthClientId": { - "description": "The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", - "maxLength": 255, - "type": "string" - }, - "oauthCustomAuthAttributes": { - "additionalProperties": { - "type": "string" - }, - "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", - "maxLength": 10000, - "type": "object" - }, - "oauthCustomScopes": { - "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", - "items": { - "maxLength": 255, - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "oauthIssuerId": { - "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", - "example": "myOidcProvider", - "maxLength": 255, - "type": "string" - }, - "oauthIssuerLocation": { - "description": "The location of your OIDC provider. This field is mandatory for OIDC IdP.", - "maxLength": 255, - "type": "string" - }, - "oauthSubjectIdClaim": { - "description": "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", - "example": "oid", - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "identityProvider" - ], - "example": "identityProvider", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiIdentityProviderOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiIdentityProviderOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiIdentityProviderOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiIdentityProviderOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiIdentityProviderPatch": { - "description": "JSON:API representation of patching identityProvider entity.", - "properties": { - "attributes": { - "properties": { - "customClaimMapping": { - "additionalProperties": { - "type": "string" - }, - "description": "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", - "maxLength": 10000, - "type": "object" - }, - "identifiers": { - "description": "List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.", - "example": [ - "gooddata.com" - ], - "items": { - "type": "string" - }, - "type": "array" - }, - "idpType": { - "description": "Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", - "enum": [ - "MANAGED_IDP", - "FIM_IDP", - "DEX_IDP", - "CUSTOM_IDP" - ], - "type": "string" - }, - "oauthClientId": { - "description": "The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", - "maxLength": 255, - "type": "string" - }, - "oauthClientSecret": { - "description": "The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.", - "maxLength": 255, - "type": "string" - }, - "oauthCustomAuthAttributes": { - "additionalProperties": { - "type": "string" - }, - "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", - "maxLength": 10000, - "type": "object" - }, - "oauthCustomScopes": { - "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", - "items": { - "maxLength": 255, - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "oauthIssuerId": { - "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", - "example": "myOidcProvider", - "maxLength": 255, - "type": "string" - }, - "oauthIssuerLocation": { - "description": "The location of your OIDC provider. This field is mandatory for OIDC IdP.", - "maxLength": 255, - "type": "string" - }, - "oauthSubjectIdClaim": { - "description": "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", - "example": "oid", - "maxLength": 255, - "type": "string" - }, - "samlMetadata": { - "description": "Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.", - "maxLength": 15000, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "identityProvider" - ], - "example": "identityProvider", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiIdentityProviderPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiIdentityProviderPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiIdentityProviderToOneLinkage": { - "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "nullable": true, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiIdentityProviderLinkage" - } - ] - }, - "JsonApiJwkIn": { - "description": "JSON:API representation of jwk entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Specification of the cryptographic key", - "example": { - "alg": "RS256", - "kyt": "RSA", - "use": "sig" - }, - "oneOf": [ - { - "$ref": "#/components/schemas/RsaSpecification" - } - ], - "type": "object" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "jwk" - ], - "example": "jwk", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiJwkInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiJwkIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiJwkOut": { - "description": "JSON:API representation of jwk entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Specification of the cryptographic key", - "example": { - "alg": "RS256", - "kyt": "RSA", - "use": "sig" - }, - "oneOf": [ - { - "$ref": "#/components/schemas/RsaSpecification" - } - ], - "type": "object" + "value" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "type": { - "description": "Object type", - "enum": [ - "jwk" - ], - "example": "jwk", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "entitlement" ], + "example" : "entitlement", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiJwkOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiJwkOut" + "JsonApiEntitlementOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiEntitlementOut" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiJwkOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiJwkOutWithLinks" + "JsonApiEntitlementOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiEntitlementOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiJwkOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiJwkOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "JsonApiEntitlementOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiEntitlementOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] }, - "JsonApiJwkPatch": { - "description": "JSON:API representation of patching jwk entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Specification of the cryptographic key", - "example": { - "alg": "RS256", - "kyt": "RSA", - "use": "sig" - }, - "oneOf": [ - { - "$ref": "#/components/schemas/RsaSpecification" - } - ], - "type": "object" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "jwk" - ], - "example": "jwk", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiJwkPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiJwkPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiKnowledgeRecommendationIn": { - "description": "JSON:API representation of knowledgeRecommendation entity.", - "properties": { - "attributes": { - "properties": { - "analyticalDashboardTitle": { - "description": "Human-readable title of the analytical dashboard (denormalized for display)", - "example": "Portfolio Health Insights", - "maxLength": 255, - "type": "string" - }, - "analyzedPeriod": { - "description": "Analyzed time period (e.g., '2023-07' or 'July 2023')", - "example": "2023-07", - "maxLength": 255, - "type": "string" - }, - "analyzedValue": { - "description": "Metric value in the analyzed period (the observed value that triggered the anomaly)", - "example": 2600000000 - }, - "areRelationsValid": { - "type": "boolean" - }, - "comparisonType": { - "description": "Time period for comparison", - "enum": [ - "MONTH", - "QUARTER", - "YEAR" - ], - "example": "MONTH", - "type": "string" - }, - "confidence": { - "description": "Confidence score (0.0 to 1.0)", - "example": 0.62 - }, - "description": { - "description": "Description of the recommendation", - "maxLength": 10000, - "type": "string" - }, - "direction": { - "description": "Direction of the metric change", - "enum": [ - "INCREASED", - "DECREASED" - ], - "example": "DECREASED", - "type": "string" - }, - "metricTitle": { - "description": "Human-readable title of the metric (denormalized for display)", - "example": "Revenue", - "maxLength": 255, - "type": "string" - }, - "recommendations": { - "description": "Structured recommendations data as JSON", - "example": "{\"summary\": \"...\", \"recommendations\": [...], \"key_metrics\": [...]}", - "type": "object" - }, - "referencePeriod": { - "description": "Reference time period for comparison (e.g., '2023-06' or 'Jun 2023')", - "example": "2023-06", - "maxLength": 255, - "type": "string" - }, - "referenceValue": { - "description": "Metric value in the reference period", - "example": 2400000000 - }, - "sourceCount": { - "description": "Number of source documents used for generation", - "example": 2, - "format": "int32", - "type": "integer" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "description": "Human-readable title for the recommendation, e.g. 'Revenue decreased vs last month'", - "maxLength": 255, - "type": "string" - }, - "widgetId": { - "description": "ID of the widget where the anomaly was detected", - "example": "widget-123", - "maxLength": 255, - "type": "string" - }, - "widgetName": { - "description": "Name of the widget where the anomaly was detected", - "example": "Revenue Trend", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "comparisonType", - "direction", - "title" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "JsonApiExportDefinitionIn" : { + "description" : "JSON:API representation of exportDefinition entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" }, - "metric": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMetricToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "required": [ - "metric" - ], - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "knowledgeRecommendation" - ], - "example": "knowledgeRecommendation", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "relationships", - "type" - ], - "type": "object" - }, - "JsonApiKnowledgeRecommendationInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiKnowledgeRecommendationOut": { - "description": "JSON:API representation of knowledgeRecommendation entity.", - "properties": { - "attributes": { - "properties": { - "analyticalDashboardTitle": { - "description": "Human-readable title of the analytical dashboard (denormalized for display)", - "example": "Portfolio Health Insights", - "maxLength": 255, - "type": "string" - }, - "analyzedPeriod": { - "description": "Analyzed time period (e.g., '2023-07' or 'July 2023')", - "example": "2023-07", - "maxLength": 255, - "type": "string" - }, - "analyzedValue": { - "description": "Metric value in the analyzed period (the observed value that triggered the anomaly)", - "example": 2600000000 - }, - "areRelationsValid": { - "type": "boolean" - }, - "comparisonType": { - "description": "Time period for comparison", - "enum": [ - "MONTH", - "QUARTER", - "YEAR" - ], - "example": "MONTH", - "type": "string" - }, - "confidence": { - "description": "Confidence score (0.0 to 1.0)", - "example": 0.62 - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "description": "Description of the recommendation", - "maxLength": 10000, - "type": "string" - }, - "direction": { - "description": "Direction of the metric change", - "enum": [ - "INCREASED", - "DECREASED" - ], - "example": "DECREASED", - "type": "string" - }, - "metricTitle": { - "description": "Human-readable title of the metric (denormalized for display)", - "example": "Revenue", - "maxLength": 255, - "type": "string" - }, - "recommendations": { - "description": "Structured recommendations data as JSON", - "example": "{\"summary\": \"...\", \"recommendations\": [...], \"key_metrics\": [...]}", - "type": "object" - }, - "referencePeriod": { - "description": "Reference time period for comparison (e.g., '2023-06' or 'Jun 2023')", - "example": "2023-06", - "maxLength": 255, - "type": "string" - }, - "referenceValue": { - "description": "Metric value in the reference period", - "example": 2400000000 - }, - "sourceCount": { - "description": "Number of source documents used for generation", - "example": 2, - "format": "int32", - "type": "integer" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "description": "Human-readable title for the recommendation, e.g. 'Revenue decreased vs last month'", - "maxLength": 255, - "type": "string" - }, - "widgetId": { - "description": "ID of the widget where the anomaly was detected", - "example": "widget-123", - "maxLength": 255, - "type": "string" - }, - "widgetName": { - "description": "Name of the widget where the anomaly was detected", - "example": "Revenue Trend", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "comparisonType", - "direction", - "title" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" - }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" - } + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "requestPayload" : { + "description" : "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", + "oneOf" : [ { + "$ref" : "#/components/schemas/VisualExportRequest" + }, { + "$ref" : "#/components/schemas/TabularExportRequest" + } ], + "type" : "object" + }, + "tags" : { + "items" : { + "type" : "string" }, - "required": [ - "originId", - "originType" - ], - "type": "object" + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "type" : "object" }, - "relationships": { - "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "analyticalDashboard" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "metric": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMetricToOneLinkage" + "visualizationObject" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "knowledgeRecommendation" - ], - "example": "knowledgeRecommendation", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "exportDefinition" ], + "example" : "exportDefinition", + "type" : "string" } }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiKnowledgeRecommendationOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOut" - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutIncludes" - }, - "type": "array", - "uniqueItems": true + "JsonApiExportDefinitionInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiExportDefinitionLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "type" : { + "enum" : [ "exportDefinition" ], + "type" : "string" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiKnowledgeRecommendationOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" - } - ] - }, - "JsonApiKnowledgeRecommendationOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutIncludes" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiKnowledgeRecommendationOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiKnowledgeRecommendationPatch": { - "description": "JSON:API representation of patching knowledgeRecommendation entity.", - "properties": { - "attributes": { - "properties": { - "analyticalDashboardTitle": { - "description": "Human-readable title of the analytical dashboard (denormalized for display)", - "example": "Portfolio Health Insights", - "maxLength": 255, - "type": "string" - }, - "analyzedPeriod": { - "description": "Analyzed time period (e.g., '2023-07' or 'July 2023')", - "example": "2023-07", - "maxLength": 255, - "type": "string" - }, - "analyzedValue": { - "description": "Metric value in the analyzed period (the observed value that triggered the anomaly)", - "example": 2600000000 - }, - "areRelationsValid": { - "type": "boolean" - }, - "comparisonType": { - "description": "Time period for comparison", - "enum": [ - "MONTH", - "QUARTER", - "YEAR" - ], - "example": "MONTH", - "type": "string" - }, - "confidence": { - "description": "Confidence score (0.0 to 1.0)", - "example": 0.62 - }, - "description": { - "description": "Description of the recommendation", - "maxLength": 10000, - "type": "string" - }, - "direction": { - "description": "Direction of the metric change", - "enum": [ - "INCREASED", - "DECREASED" - ], - "example": "DECREASED", - "type": "string" - }, - "metricTitle": { - "description": "Human-readable title of the metric (denormalized for display)", - "example": "Revenue", - "maxLength": 255, - "type": "string" - }, - "recommendations": { - "description": "Structured recommendations data as JSON", - "example": "{\"summary\": \"...\", \"recommendations\": [...], \"key_metrics\": [...]}", - "type": "object" - }, - "referencePeriod": { - "description": "Reference time period for comparison (e.g., '2023-06' or 'Jun 2023')", - "example": "2023-06", - "maxLength": 255, - "type": "string" - }, - "referenceValue": { - "description": "Metric value in the reference period", - "example": 2400000000 - }, - "sourceCount": { - "description": "Number of source documents used for generation", - "example": 2, - "format": "int32", - "type": "integer" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "description": "Human-readable title for the recommendation, e.g. 'Revenue decreased vs last month'", - "maxLength": 255, - "type": "string" - }, - "widgetId": { - "description": "ID of the widget where the anomaly was detected", - "example": "widget-123", - "maxLength": 255, - "type": "string" - }, - "widgetName": { - "description": "Name of the widget where the anomaly was detected", - "example": "Revenue Trend", - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" - } + "JsonApiExportDefinitionOut" : { + "description" : "JSON:API representation of exportDefinition entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "createdAt" : { + "description" : "Time of the entity creation.", + "format" : "date-time", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "modifiedAt" : { + "description" : "Time of the last entity modification.", + "format" : "date-time", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "requestPayload" : { + "description" : "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", + "oneOf" : [ { + "$ref" : "#/components/schemas/VisualExportRequest" + }, { + "$ref" : "#/components/schemas/TabularExportRequest" + } ], + "type" : "object" + }, + "tags" : { + "items" : { + "type" : "string" }, - "required": [ - "data" - ], - "type": "object" + "type" : "array" }, - "metric": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMetricToOneLinkage" + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" + }, + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" } }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "knowledgeRecommendation" - ], - "example": "knowledgeRecommendation", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "relationships", - "type" - ], - "type": "object" - }, - "JsonApiKnowledgeRecommendationPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiKnowledgeRecommendationPostOptionalId": { - "description": "JSON:API representation of knowledgeRecommendation entity.", - "properties": { - "attributes": { - "properties": { - "analyticalDashboardTitle": { - "description": "Human-readable title of the analytical dashboard (denormalized for display)", - "example": "Portfolio Health Insights", - "maxLength": 255, - "type": "string" - }, - "analyzedPeriod": { - "description": "Analyzed time period (e.g., '2023-07' or 'July 2023')", - "example": "2023-07", - "maxLength": 255, - "type": "string" - }, - "analyzedValue": { - "description": "Metric value in the analyzed period (the observed value that triggered the anomaly)", - "example": 2600000000 - }, - "areRelationsValid": { - "type": "boolean" - }, - "comparisonType": { - "description": "Time period for comparison", - "enum": [ - "MONTH", - "QUARTER", - "YEAR" - ], - "example": "MONTH", - "type": "string" - }, - "confidence": { - "description": "Confidence score (0.0 to 1.0)", - "example": 0.62 - }, - "description": { - "description": "Description of the recommendation", - "maxLength": 10000, - "type": "string" - }, - "direction": { - "description": "Direction of the metric change", - "enum": [ - "INCREASED", - "DECREASED" - ], - "example": "DECREASED", - "type": "string" - }, - "metricTitle": { - "description": "Human-readable title of the metric (denormalized for display)", - "example": "Revenue", - "maxLength": 255, - "type": "string" - }, - "recommendations": { - "description": "Structured recommendations data as JSON", - "example": "{\"summary\": \"...\", \"recommendations\": [...], \"key_metrics\": [...]}", - "type": "object" - }, - "referencePeriod": { - "description": "Reference time period for comparison (e.g., '2023-06' or 'Jun 2023')", - "example": "2023-06", - "maxLength": 255, - "type": "string" - }, - "referenceValue": { - "description": "Metric value in the reference period", - "example": 2400000000 - }, - "sourceCount": { - "description": "Number of source documents used for generation", - "example": 2, - "format": "int32", - "type": "integer" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "description": "Human-readable title for the recommendation, e.g. 'Revenue decreased vs last month'", - "maxLength": 255, - "type": "string" - }, - "widgetId": { - "description": "ID of the widget where the anomaly was detected", - "example": "widget-123", - "maxLength": 255, - "type": "string" - }, - "widgetName": { - "description": "Name of the widget where the anomaly was detected", - "example": "Revenue Trend", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "comparisonType", - "direction", - "title" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" + "required" : [ "originId", "originType" ], + "type" : "object" + } + }, + "type" : "object" + }, + "relationships" : { + "properties" : { + "analyticalDashboard" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "metric": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMetricToOneLinkage" + "automation" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAutomationToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" - } - }, - "required": [ - "metric" - ], - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "knowledgeRecommendation" - ], - "example": "knowledgeRecommendation", - "type": "string" - } - }, - "required": [ - "attributes", - "relationships", - "type" - ], - "type": "object" - }, - "JsonApiKnowledgeRecommendationPostOptionalIdDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalId" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiLabelLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "label" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiLabelOut": { - "description": "JSON:API representation of label entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "geoAreaConfig": { - "description": "Configuration specific to geo area labels.", - "properties": { - "collection": { - "$ref": "#/components/schemas/GeoCollectionIdentifier" + "required" : [ "data" ], + "type" : "object" + }, + "createdBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, - "required": [ - "collection" - ], - "type": "object" - }, - "isHidden": { - "type": "boolean" - }, - "isNullable": { - "type": "boolean" - }, - "locale": { - "type": "string" - }, - "nullValue": { - "type": "string" - }, - "primary": { - "type": "boolean" - }, - "sourceColumn": { - "maxLength": 255, - "type": "string" - }, - "sourceColumnDataType": { - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - }, - "translations": { - "items": { - "properties": { - "locale": { - "type": "string" - }, - "sourceColumn": { - "type": "string" - } - }, - "required": [ - "locale", - "sourceColumn" - ], - "type": "object" - }, - "type": "array" - }, - "valueType": { - "enum": [ - "TEXT", - "HYPERLINK", - "GEO", - "GEO_LONGITUDE", - "GEO_LATITUDE", - "GEO_AREA", - "IMAGE" - ], - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" - }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" + "required" : [ "data" ], + "type" : "object" + }, + "modifiedBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, - "required": [ - "originId", - "originType" - ], - "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "attribute": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeToOneLinkage" + "required" : [ "data" ], + "type" : "object" + }, + "visualizationObject" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "label" - ], - "example": "label", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "exportDefinition" ], + "example" : "exportDefinition", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiLabelOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiLabelOut" + "JsonApiExportDefinitionOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOut" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOutIncludes" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiLabelOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" + "JsonApiExportDefinitionOutIncludes" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiAutomationOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + } ] + }, + "JsonApiExportDefinitionOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOutIncludes" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiLabelOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiLabelOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "JsonApiExportDefinitionOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] }, - "JsonApiLabelPatch": { - "description": "JSON:API representation of patching label entity.", - "properties": { - "attributes": { - "properties": { - "description": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "label" - ], - "example": "label", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiLabelPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiLabelPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiLabelToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiLabelLinkage" - }, - "type": "array" - }, - "JsonApiLabelToOneLinkage": { - "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "nullable": true, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiLabelLinkage" - } - ] - }, - "JsonApiLlmEndpointIn": { - "description": "JSON:API representation of llmEndpoint entity.", - "properties": { - "attributes": { - "properties": { - "baseUrl": { - "description": "Custom LLM endpoint.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "llmModel": { - "description": "LLM Model. We provide a default model for each provider, but you can override it here.", - "maxLength": 255, - "type": "string" - }, - "llmOrganization": { - "description": "Organization in LLM provider.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "provider": { - "description": "LLM Provider.", - "enum": [ - "OPENAI", - "AZURE_OPENAI" - ], - "type": "string" - }, - "title": { - "description": "User-facing title of the LLM Provider.", - "maxLength": 255, - "type": "string" - }, - "token": { - "description": "The token to use to connect to the LLM provider.", - "maxLength": 10000, - "type": "string" - } - }, - "required": [ - "title", - "token" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "llmEndpoint" - ], - "example": "llmEndpoint", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiLlmEndpointInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiLlmEndpointIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiLlmEndpointOut": { - "description": "JSON:API representation of llmEndpoint entity.", - "properties": { - "attributes": { - "properties": { - "baseUrl": { - "description": "Custom LLM endpoint.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "llmModel": { - "description": "LLM Model. We provide a default model for each provider, but you can override it here.", - "maxLength": 255, - "type": "string" - }, - "llmOrganization": { - "description": "Organization in LLM provider.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "provider": { - "description": "LLM Provider.", - "enum": [ - "OPENAI", - "AZURE_OPENAI" - ], - "type": "string" - }, - "title": { - "description": "User-facing title of the LLM Provider.", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "title" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "llmEndpoint" - ], - "example": "llmEndpoint", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiLlmEndpointOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiLlmEndpointOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiLlmEndpointOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiLlmEndpointOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiLlmEndpointOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiLlmEndpointOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiLlmEndpointPatch": { - "description": "JSON:API representation of patching llmEndpoint entity.", - "properties": { - "attributes": { - "properties": { - "baseUrl": { - "description": "Custom LLM endpoint.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "llmModel": { - "description": "LLM Model. We provide a default model for each provider, but you can override it here.", - "maxLength": 255, - "type": "string" - }, - "llmOrganization": { - "description": "Organization in LLM provider.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "provider": { - "description": "LLM Provider.", - "enum": [ - "OPENAI", - "AZURE_OPENAI" - ], - "type": "string" - }, - "title": { - "description": "User-facing title of the LLM Provider.", - "maxLength": 255, - "type": "string" - }, - "token": { - "description": "The token to use to connect to the LLM provider.", - "maxLength": 10000, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "llmEndpoint" - ], - "example": "llmEndpoint", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiLlmEndpointPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiLlmEndpointPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiMemoryItemIn": { - "description": "JSON:API representation of memoryItem entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "instruction": { - "description": "The text that will be injected into the system prompt", - "maxLength": 255, - "type": "string" - }, - "isDisabled": { - "description": "Whether memory item is disabled", - "type": "boolean" - }, - "keywords": { - "description": "Set of unique strings used for semantic similarity filtering", - "items": { - "type": "string" - }, - "type": "array" - }, - "strategy": { - "description": "Strategy defining when the memory item should be applied", - "enum": [ - "ALWAYS", - "AUTO" - ], - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "instruction", - "strategy" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "memoryItem" - ], - "example": "memoryItem", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiMemoryItemInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMemoryItemIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiMemoryItemOut": { - "description": "JSON:API representation of memoryItem entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "instruction": { - "description": "The text that will be injected into the system prompt", - "maxLength": 255, - "type": "string" - }, - "isDisabled": { - "description": "Whether memory item is disabled", - "type": "boolean" - }, - "keywords": { - "description": "Set of unique strings used for semantic similarity filtering", - "items": { - "type": "string" - }, - "type": "array" - }, - "modifiedAt": { - "format": "date-time", - "type": "string" - }, - "strategy": { - "description": "Strategy defining when the memory item should be applied", - "enum": [ - "ALWAYS", - "AUTO" - ], - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "instruction", - "strategy" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" - }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" - } + "JsonApiExportDefinitionPatch" : { + "description" : "JSON:API representation of patching exportDefinition entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "requestPayload" : { + "description" : "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", + "oneOf" : [ { + "$ref" : "#/components/schemas/VisualExportRequest" + }, { + "$ref" : "#/components/schemas/TabularExportRequest" + } ], + "type" : "object" + }, + "tags" : { + "items" : { + "type" : "string" }, - "required": [ - "originId", - "originType" - ], - "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "createdBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "analyticalDashboard" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "modifiedBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + "visualizationObject" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "memoryItem" - ], - "example": "memoryItem", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "exportDefinition" ], + "example" : "exportDefinition", + "type" : "string" } }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiMemoryItemOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMemoryItemOut" - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "JsonApiExportDefinitionPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionPatch" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiMemoryItemOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + "JsonApiExportDefinitionPostOptionalId" : { + "description" : "JSON:API representation of exportDefinition entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "requestPayload" : { + "description" : "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", + "oneOf" : [ { + "$ref" : "#/components/schemas/VisualExportRequest" + }, { + "$ref" : "#/components/schemas/TabularExportRequest" + } ], + "type" : "object" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } }, - "type": "array", - "uniqueItems": true + "type" : "object" }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "relationships" : { + "properties" : { + "analyticalDashboard" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "visualizationObject" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "exportDefinition" ], + "example" : "exportDefinition", + "type" : "string" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "type" ], + "type" : "object" }, - "JsonApiMemoryItemOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiMemoryItemOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" + "JsonApiExportDefinitionPostOptionalIdDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionPostOptionalId" } - ] + }, + "required" : [ "data" ], + "type" : "object" }, - "JsonApiMemoryItemPatch": { - "description": "JSON:API representation of patching memoryItem entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "instruction": { - "description": "The text that will be injected into the system prompt", - "maxLength": 255, - "type": "string" - }, - "isDisabled": { - "description": "Whether memory item is disabled", - "type": "boolean" - }, - "keywords": { - "description": "Set of unique strings used for semantic similarity filtering", - "items": { - "type": "string" - }, - "type": "array" - }, - "strategy": { - "description": "Strategy defining when the memory item should be applied", - "enum": [ - "ALWAYS", - "AUTO" - ], - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "memoryItem" - ], - "example": "memoryItem", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiMemoryItemPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMemoryItemPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiMemoryItemPostOptionalId": { - "description": "JSON:API representation of memoryItem entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "instruction": { - "description": "The text that will be injected into the system prompt", - "maxLength": 255, - "type": "string" - }, - "isDisabled": { - "description": "Whether memory item is disabled", - "type": "boolean" - }, - "keywords": { - "description": "Set of unique strings used for semantic similarity filtering", - "items": { - "type": "string" - }, - "type": "array" - }, - "strategy": { - "description": "Strategy defining when the memory item should be applied", - "enum": [ - "ALWAYS", - "AUTO" - ], - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "instruction", - "strategy" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "memoryItem" - ], - "example": "memoryItem", - "type": "string" - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - }, - "JsonApiMemoryItemPostOptionalIdDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalId" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiMetricIn": { - "description": "JSON:API representation of metric entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "properties": { - "format": { - "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", - "maxLength": 2048, - "nullable": true, - "type": "string" + "JsonApiExportDefinitionToManyLinkage" : { + "description" : "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionLinkage" + }, + "type" : "array" + }, + "JsonApiExportTemplateIn" : { + "description" : "JSON:API representation of exportTemplate entity.", + "properties" : { + "attributes" : { + "properties" : { + "dashboardSlidesTemplate" : { + "description" : "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable" : true, + "properties" : { + "appliedOn" : { + "description" : "Export types this template applies to.", + "example" : [ "PDF", "PPTX" ], + "items" : { + "enum" : [ "PDF", "PPTX" ], + "type" : "string" + }, + "minItems" : 1, + "type" : "array" }, - "maql": { - "maxLength": 10000, - "type": "string" + "contentSlide" : { + "$ref" : "#/components/schemas/ContentSlideTemplate" }, - "metricType": { - "description": "Categorizes metric semantics (e.g., currency).", - "enum": [ - "UNSPECIFIED", - "CURRENCY" - ], - "type": "string" - } - }, - "required": [ - "maql" - ], - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "isHidden": { - "type": "boolean" - }, - "isHiddenFromKda": { - "type": "boolean" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "metric" - ], - "example": "metric", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiMetricInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMetricIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiMetricLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "metric" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiMetricOut": { - "description": "JSON:API representation of metric entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "properties": { - "format": { - "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", - "maxLength": 2048, - "nullable": true, - "type": "string" + "coverSlide" : { + "$ref" : "#/components/schemas/CoverSlideTemplate" }, - "maql": { - "maxLength": 10000, - "type": "string" + "introSlide" : { + "$ref" : "#/components/schemas/IntroSlideTemplate" }, - "metricType": { - "description": "Categorizes metric semantics (e.g., currency).", - "enum": [ - "UNSPECIFIED", - "CURRENCY" - ], - "type": "string" + "sectionSlide" : { + "$ref" : "#/components/schemas/SectionSlideTemplate" } }, - "required": [ - "maql" - ], - "type": "object" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "isHidden": { - "type": "boolean" - }, - "isHiddenFromKda": { - "type": "boolean" - }, - "modifiedAt": { - "format": "date-time", - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" + "required" : [ "appliedOn" ], + "type" : "object" + }, + "name" : { + "description" : "User-facing name of the Slides template.", + "maxLength" : 255, + "type" : "string" + }, + "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, + "properties" : { + "appliedOn" : { + "description" : "Export types this template applies to.", + "example" : [ "PDF", "PPTX" ], + "items" : { + "enum" : [ "PDF", "PPTX" ], + "type" : "string" + }, + "minItems" : 1, + "type" : "array" }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" - } - }, - "required": [ - "originId", - "originType" - ], - "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "attributes": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "createdBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "datasets": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "facts": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFactToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "labels": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" + "contentSlide" : { + "$ref" : "#/components/schemas/ContentSlideTemplate" } }, - "required": [ - "data" - ], - "type": "object" - }, - "metrics": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" + "required" : [ "appliedOn" ], + "type" : "object" + } + }, + "required" : [ "name" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "exportTemplate" ], + "example" : "exportTemplate", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiExportTemplateInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiExportTemplateIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiExportTemplateOut" : { + "description" : "JSON:API representation of exportTemplate entity.", + "properties" : { + "attributes" : { + "properties" : { + "dashboardSlidesTemplate" : { + "description" : "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable" : true, + "properties" : { + "appliedOn" : { + "description" : "Export types this template applies to.", + "example" : [ "PDF", "PPTX" ], + "items" : { + "enum" : [ "PDF", "PPTX" ], + "type" : "string" + }, + "minItems" : 1, + "type" : "array" + }, + "contentSlide" : { + "$ref" : "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide" : { + "$ref" : "#/components/schemas/CoverSlideTemplate" + }, + "introSlide" : { + "$ref" : "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide" : { + "$ref" : "#/components/schemas/SectionSlideTemplate" } }, - "required": [ - "data" - ], - "type": "object" - }, - "modifiedBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + "required" : [ "appliedOn" ], + "type" : "object" + }, + "name" : { + "description" : "User-facing name of the Slides template.", + "maxLength" : 255, + "type" : "string" + }, + "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, + "properties" : { + "appliedOn" : { + "description" : "Export types this template applies to.", + "example" : [ "PDF", "PPTX" ], + "items" : { + "enum" : [ "PDF", "PPTX" ], + "type" : "string" + }, + "minItems" : 1, + "type" : "array" + }, + "contentSlide" : { + "$ref" : "#/components/schemas/ContentSlideTemplate" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "appliedOn" ], + "type" : "object" } }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "metric" - ], - "example": "metric", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiMetricOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMetricOut" + "required" : [ "name" ], + "type" : "object" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" - }, - "type": "array", - "uniqueItems": true + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "type" : { + "description" : "Object type", + "enum" : [ "exportTemplate" ], + "example" : "exportTemplate", + "type" : "string" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiMetricOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiFactOutWithLinks" + "JsonApiExportTemplateOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiExportTemplateOut" }, - { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } - ] + }, + "required" : [ "data" ], + "type" : "object" }, - "JsonApiMetricOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" + "JsonApiExportTemplateOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiExportTemplateOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiMetricOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiMetricOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "JsonApiExportTemplateOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiExportTemplateOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] }, - "JsonApiMetricPatch": { - "description": "JSON:API representation of patching metric entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "properties": { - "format": { - "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", - "maxLength": 2048, - "nullable": true, - "type": "string" + "JsonApiExportTemplatePatch" : { + "description" : "JSON:API representation of patching exportTemplate entity.", + "properties" : { + "attributes" : { + "properties" : { + "dashboardSlidesTemplate" : { + "description" : "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable" : true, + "properties" : { + "appliedOn" : { + "description" : "Export types this template applies to.", + "example" : [ "PDF", "PPTX" ], + "items" : { + "enum" : [ "PDF", "PPTX" ], + "type" : "string" + }, + "minItems" : 1, + "type" : "array" }, - "maql": { - "maxLength": 10000, - "type": "string" + "contentSlide" : { + "$ref" : "#/components/schemas/ContentSlideTemplate" }, - "metricType": { - "description": "Categorizes metric semantics (e.g., currency).", - "enum": [ - "UNSPECIFIED", - "CURRENCY" - ], - "type": "string" - } - }, - "required": [ - "maql" - ], - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "isHidden": { - "type": "boolean" - }, - "isHiddenFromKda": { - "type": "boolean" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "metric" - ], - "example": "metric", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiMetricPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMetricPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiMetricPostOptionalId": { - "description": "JSON:API representation of metric entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "properties": { - "format": { - "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", - "maxLength": 2048, - "nullable": true, - "type": "string" + "coverSlide" : { + "$ref" : "#/components/schemas/CoverSlideTemplate" }, - "maql": { - "maxLength": 10000, - "type": "string" + "introSlide" : { + "$ref" : "#/components/schemas/IntroSlideTemplate" }, - "metricType": { - "description": "Categorizes metric semantics (e.g., currency).", - "enum": [ - "UNSPECIFIED", - "CURRENCY" - ], - "type": "string" + "sectionSlide" : { + "$ref" : "#/components/schemas/SectionSlideTemplate" } }, - "required": [ - "maql" - ], - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "isHidden": { - "type": "boolean" - }, - "isHiddenFromKda": { - "type": "boolean" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "metric" - ], - "example": "metric", - "type": "string" - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - }, - "JsonApiMetricPostOptionalIdDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMetricPostOptionalId" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiMetricToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiMetricLinkage" - }, - "type": "array" - }, - "JsonApiMetricToOneLinkage": { - "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "nullable": true, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiMetricLinkage" - } - ] - }, - "JsonApiNotificationChannelIdentifierOut": { - "description": "JSON:API representation of notificationChannelIdentifier entity.", - "properties": { - "attributes": { - "properties": { - "allowedRecipients": { - "description": "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", - "enum": [ - "CREATOR", - "INTERNAL", - "EXTERNAL" - ], - "type": "string" - }, - "description": { - "maxLength": 10000, - "nullable": true, - "type": "string" - }, - "destinationType": { - "enum": [ - "WEBHOOK", - "SMTP", - "DEFAULT_SMTP", - "IN_PLATFORM" - ], - "type": "string" - }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "notificationChannelIdentifier" - ], - "example": "notificationChannelIdentifier", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiNotificationChannelIdentifierOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiNotificationChannelIdentifierOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiNotificationChannelIdentifierOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiNotificationChannelIn": { - "description": "JSON:API representation of notificationChannel entity.", - "properties": { - "attributes": { - "properties": { - "allowedRecipients": { - "description": "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", - "enum": [ - "CREATOR", - "INTERNAL", - "EXTERNAL" - ], - "type": "string" - }, - "customDashboardUrl": { - "description": "Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are:\n{workspaceId}\n{dashboardId}\n{automationId}\n{asOfDate}\n", - "maxLength": 255, - "type": "string" - }, - "dashboardLinkVisibility": { - "description": "Dashboard link visibility in notifications.\nHIDDEN - the link will not be included\nINTERNAL_ONLY - only internal users will see the link\nALL - all users will see the link\n", - "enum": [ - "HIDDEN", - "INTERNAL_ONLY", - "ALL" - ], - "type": "string" - }, - "description": { - "maxLength": 10000, - "nullable": true, - "type": "string" - }, - "destination": { - "description": "The destination where the notifications are to be sent.", - "oneOf": [ - { - "$ref": "#/components/schemas/DefaultSmtp" - }, - { - "$ref": "#/components/schemas/InPlatform" - }, - { - "$ref": "#/components/schemas/Smtp" - }, - { - "$ref": "#/components/schemas/Webhook" - } - ] - }, - "inPlatformNotification": { - "description": "In-platform notifications configuration. No effect if the destination type is IN_PLATFORM.\nDISABLED - in-platform notifications are not sent\nENABLED - in-platform notifications are sent in addition to the regular notifications\n", - "enum": [ - "DISABLED", - "ENABLED" - ], - "type": "string" - }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "notificationSource": { - "description": "Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are:\n{{workspaceId}}\n{{workspaceName}}\n{{workspaceDescription}}\n{{dashboardId}}\n{{dashboardName}}\n{{dashboardDescription}}\n", - "maxLength": 10000, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "notificationChannel" - ], - "example": "notificationChannel", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiNotificationChannelInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiNotificationChannelIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiNotificationChannelLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "notificationChannel" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiNotificationChannelOut": { - "description": "JSON:API representation of notificationChannel entity.", - "properties": { - "attributes": { - "properties": { - "allowedRecipients": { - "description": "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", - "enum": [ - "CREATOR", - "INTERNAL", - "EXTERNAL" - ], - "type": "string" - }, - "customDashboardUrl": { - "description": "Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are:\n{workspaceId}\n{dashboardId}\n{automationId}\n{asOfDate}\n", - "maxLength": 255, - "type": "string" - }, - "dashboardLinkVisibility": { - "description": "Dashboard link visibility in notifications.\nHIDDEN - the link will not be included\nINTERNAL_ONLY - only internal users will see the link\nALL - all users will see the link\n", - "enum": [ - "HIDDEN", - "INTERNAL_ONLY", - "ALL" - ], - "type": "string" - }, - "description": { - "maxLength": 10000, - "nullable": true, - "type": "string" - }, - "destination": { - "description": "The destination where the notifications are to be sent.", - "oneOf": [ - { - "$ref": "#/components/schemas/DefaultSmtp" - }, - { - "$ref": "#/components/schemas/InPlatform" - }, - { - "$ref": "#/components/schemas/Smtp" + "required" : [ "appliedOn" ], + "type" : "object" + }, + "name" : { + "description" : "User-facing name of the Slides template.", + "maxLength" : 255, + "type" : "string" + }, + "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, + "properties" : { + "appliedOn" : { + "description" : "Export types this template applies to.", + "example" : [ "PDF", "PPTX" ], + "items" : { + "enum" : [ "PDF", "PPTX" ], + "type" : "string" + }, + "minItems" : 1, + "type" : "array" }, - { - "$ref": "#/components/schemas/Webhook" + "contentSlide" : { + "$ref" : "#/components/schemas/ContentSlideTemplate" } - ] - }, - "destinationType": { - "enum": [ - "WEBHOOK", - "SMTP", - "DEFAULT_SMTP", - "IN_PLATFORM" - ], - "nullable": true, - "type": "string" - }, - "inPlatformNotification": { - "description": "In-platform notifications configuration. No effect if the destination type is IN_PLATFORM.\nDISABLED - in-platform notifications are not sent\nENABLED - in-platform notifications are sent in addition to the regular notifications\n", - "enum": [ - "DISABLED", - "ENABLED" - ], - "type": "string" - }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "notificationSource": { - "description": "Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are:\n{{workspaceId}}\n{{workspaceName}}\n{{workspaceDescription}}\n{{dashboardId}}\n{{dashboardName}}\n{{dashboardDescription}}\n", - "maxLength": 10000, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "notificationChannel" - ], - "example": "notificationChannel", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiNotificationChannelOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiNotificationChannelOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiNotificationChannelOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiNotificationChannelOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiNotificationChannelPatch": { - "description": "JSON:API representation of patching notificationChannel entity.", - "properties": { - "attributes": { - "properties": { - "allowedRecipients": { - "description": "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", - "enum": [ - "CREATOR", - "INTERNAL", - "EXTERNAL" - ], - "type": "string" - }, - "customDashboardUrl": { - "description": "Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are:\n{workspaceId}\n{dashboardId}\n{automationId}\n{asOfDate}\n", - "maxLength": 255, - "type": "string" - }, - "dashboardLinkVisibility": { - "description": "Dashboard link visibility in notifications.\nHIDDEN - the link will not be included\nINTERNAL_ONLY - only internal users will see the link\nALL - all users will see the link\n", - "enum": [ - "HIDDEN", - "INTERNAL_ONLY", - "ALL" - ], - "type": "string" - }, - "description": { - "maxLength": 10000, - "nullable": true, - "type": "string" - }, - "destination": { - "description": "The destination where the notifications are to be sent.", - "oneOf": [ - { - "$ref": "#/components/schemas/DefaultSmtp" - }, - { - "$ref": "#/components/schemas/InPlatform" - }, - { - "$ref": "#/components/schemas/Smtp" + }, + "required" : [ "appliedOn" ], + "type" : "object" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "exportTemplate" ], + "example" : "exportTemplate", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiExportTemplatePatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiExportTemplatePatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiExportTemplatePostOptionalId" : { + "description" : "JSON:API representation of exportTemplate entity.", + "properties" : { + "attributes" : { + "properties" : { + "dashboardSlidesTemplate" : { + "description" : "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable" : true, + "properties" : { + "appliedOn" : { + "description" : "Export types this template applies to.", + "example" : [ "PDF", "PPTX" ], + "items" : { + "enum" : [ "PDF", "PPTX" ], + "type" : "string" + }, + "minItems" : 1, + "type" : "array" }, - { - "$ref": "#/components/schemas/Webhook" - } - ] - }, - "inPlatformNotification": { - "description": "In-platform notifications configuration. No effect if the destination type is IN_PLATFORM.\nDISABLED - in-platform notifications are not sent\nENABLED - in-platform notifications are sent in addition to the regular notifications\n", - "enum": [ - "DISABLED", - "ENABLED" - ], - "type": "string" - }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "notificationSource": { - "description": "Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are:\n{{workspaceId}}\n{{workspaceName}}\n{{workspaceDescription}}\n{{dashboardId}}\n{{dashboardName}}\n{{dashboardDescription}}\n", - "maxLength": 10000, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "notificationChannel" - ], - "example": "notificationChannel", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiNotificationChannelPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiNotificationChannelPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiNotificationChannelPostOptionalId": { - "description": "JSON:API representation of notificationChannel entity.", - "properties": { - "attributes": { - "properties": { - "allowedRecipients": { - "description": "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", - "enum": [ - "CREATOR", - "INTERNAL", - "EXTERNAL" - ], - "type": "string" - }, - "customDashboardUrl": { - "description": "Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are:\n{workspaceId}\n{dashboardId}\n{automationId}\n{asOfDate}\n", - "maxLength": 255, - "type": "string" - }, - "dashboardLinkVisibility": { - "description": "Dashboard link visibility in notifications.\nHIDDEN - the link will not be included\nINTERNAL_ONLY - only internal users will see the link\nALL - all users will see the link\n", - "enum": [ - "HIDDEN", - "INTERNAL_ONLY", - "ALL" - ], - "type": "string" - }, - "description": { - "maxLength": 10000, - "nullable": true, - "type": "string" - }, - "destination": { - "description": "The destination where the notifications are to be sent.", - "oneOf": [ - { - "$ref": "#/components/schemas/DefaultSmtp" + "contentSlide" : { + "$ref" : "#/components/schemas/ContentSlideTemplate" }, - { - "$ref": "#/components/schemas/InPlatform" + "coverSlide" : { + "$ref" : "#/components/schemas/CoverSlideTemplate" }, - { - "$ref": "#/components/schemas/Smtp" + "introSlide" : { + "$ref" : "#/components/schemas/IntroSlideTemplate" }, - { - "$ref": "#/components/schemas/Webhook" - } - ] - }, - "inPlatformNotification": { - "description": "In-platform notifications configuration. No effect if the destination type is IN_PLATFORM.\nDISABLED - in-platform notifications are not sent\nENABLED - in-platform notifications are sent in addition to the regular notifications\n", - "enum": [ - "DISABLED", - "ENABLED" - ], - "type": "string" - }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "notificationSource": { - "description": "Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are:\n{{workspaceId}}\n{{workspaceName}}\n{{workspaceDescription}}\n{{dashboardId}}\n{{dashboardName}}\n{{dashboardDescription}}\n", - "maxLength": 10000, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "notificationChannel" - ], - "example": "notificationChannel", - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "JsonApiNotificationChannelPostOptionalIdDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiNotificationChannelPostOptionalId" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiNotificationChannelToOneLinkage": { - "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "nullable": true, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiNotificationChannelLinkage" - } - ] - }, - "JsonApiOrganizationIn": { - "description": "JSON:API representation of organization entity.", - "properties": { - "attributes": { - "properties": { - "allowedOrigins": { - "items": { - "type": "string" - }, - "type": "array" - }, - "earlyAccess": { - "deprecated": true, - "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "earlyAccessValues": { - "description": "The early access feature identifiers. They are used to enable experimental features.", - "items": { - "maxLength": 255, - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "hostname": { - "maxLength": 255, - "type": "string" - }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "identityProvider": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiIdentityProviderToOneLinkage" + "sectionSlide" : { + "$ref" : "#/components/schemas/SectionSlideTemplate" } }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "organization" - ], - "example": "organization", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiOrganizationInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiOrganizationIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiOrganizationOut": { - "description": "JSON:API representation of organization entity.", - "properties": { - "attributes": { - "properties": { - "allowedOrigins": { - "items": { - "type": "string" - }, - "type": "array" - }, - "cacheSettings": { - "properties": { - "cacheStrategy": { - "enum": [ - "DURABLE", - "EPHEMERAL" - ], - "maxLength": 255, - "type": "string" + "required" : [ "appliedOn" ], + "type" : "object" + }, + "name" : { + "description" : "User-facing name of the Slides template.", + "maxLength" : 255, + "type" : "string" + }, + "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, + "properties" : { + "appliedOn" : { + "description" : "Export types this template applies to.", + "example" : [ "PDF", "PPTX" ], + "items" : { + "enum" : [ "PDF", "PPTX" ], + "type" : "string" + }, + "minItems" : 1, + "type" : "array" }, - "extraCacheBudget": { - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "dataCenter": { - "description": "Current deployment region. Should be used for issue investigation only.", - "nullable": true, - "type": "string" - }, - "earlyAccess": { - "deprecated": true, - "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "earlyAccessValues": { - "description": "The early access feature identifiers. They are used to enable experimental features.", - "items": { - "maxLength": 255, - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "hostname": { - "maxLength": 255, - "type": "string" - }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "region": { - "description": "Current deployment cluster name. Should be used for issue investigation only.", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "permissions": { - "description": "List of valid permissions for a logged-in user.", - "items": { - "enum": [ - "MANAGE", - "SELF_CREATE_TOKEN" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "bootstrapUser": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "bootstrapUserGroup": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "identityProvider": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiIdentityProviderToOneLinkage" + "contentSlide" : { + "$ref" : "#/components/schemas/ContentSlideTemplate" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "appliedOn" ], + "type" : "object" } }, - "type": "object" + "required" : [ "name" ], + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "organization" - ], - "example": "organization", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "exportTemplate" ], + "example" : "exportTemplate", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "attributes", "type" ], + "type" : "object" }, - "JsonApiOrganizationOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiOrganizationOut" - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiOrganizationOutIncludes" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "JsonApiExportTemplatePostOptionalIdDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiExportTemplatePostOptionalId" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiOrganizationOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiUserOutWithLinks" + "JsonApiFactLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" }, - { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutWithLinks" + "type" : { + "enum" : [ "fact" ], + "type" : "string" } - ] + }, + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiOrganizationPatch": { - "description": "JSON:API representation of patching organization entity.", - "properties": { - "attributes": { - "properties": { - "allowedOrigins": { - "items": { - "type": "string" - }, - "type": "array" + "JsonApiFactOut" : { + "description" : "JSON:API representation of fact entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" }, - "earlyAccess": { - "deprecated": true, - "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", - "maxLength": 255, - "nullable": true, - "type": "string" + "description" : { + "maxLength" : 10000, + "type" : "string" }, - "earlyAccessValues": { - "description": "The early access feature identifiers. They are used to enable experimental features.", - "items": { - "maxLength": 255, - "type": "string" - }, - "nullable": true, - "type": "array" + "isHidden" : { + "type" : "boolean" }, - "hostname": { - "maxLength": 255, - "type": "string" + "isNullable" : { + "type" : "boolean" }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" + "nullValue" : { + "type" : "string" + }, + "sourceColumn" : { + "maxLength" : 255, + "type" : "string" + }, + "sourceColumnDataType" : { + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "relationships": { - "properties": { - "identityProvider": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiIdentityProviderToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "organization" - ], - "example": "organization", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiOrganizationPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiOrganizationPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiOrganizationSettingIn": { - "description": "JSON:API representation of organizationSetting entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_ENDPOINT", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "SORT_CASE_SENSITIVE", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS" - ], - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "organizationSetting" - ], - "example": "organizationSetting", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiOrganizationSettingInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiOrganizationSettingOut": { - "description": "JSON:API representation of organizationSetting entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_ENDPOINT", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "SORT_CASE_SENSITIVE", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS" - ], - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "organizationSetting" - ], - "example": "organizationSetting", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiOrganizationSettingOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiOrganizationSettingOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiOrganizationSettingOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiOrganizationSettingPatch": { - "description": "JSON:API representation of patching organizationSetting entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_ENDPOINT", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "SORT_CASE_SENSITIVE", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS" - ], - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "organizationSetting" - ], - "example": "organizationSetting", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiOrganizationSettingPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiThemeIn": { - "description": "JSON:API representation of theme entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "name": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content", - "name" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "theme" - ], - "example": "theme", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiThemeInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiThemeIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiThemeOut": { - "description": "JSON:API representation of theme entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "name": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content", - "name" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "theme" - ], - "example": "theme", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiThemeOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiThemeOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiThemeOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiThemeOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiThemeOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiThemeOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiThemePatch": { - "description": "JSON:API representation of patching theme entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "name": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "theme" - ], - "example": "theme", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiThemePatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiThemePatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserDataFilterIn": { - "description": "JSON:API representation of userDataFilter entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "maql": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "maql" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "user": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "userGroup": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "userDataFilter" - ], - "example": "userDataFilter", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiUserDataFilterInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserDataFilterOut": { - "description": "JSON:API representation of userDataFilter entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "maql": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "maql" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" } }, - "required": [ - "originId", - "originType" - ], - "type": "object" + "required" : [ "originId", "originType" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "relationships": { - "properties": { - "attributes": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "datasets": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "facts": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFactToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "labels": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" + "relationships" : { + "properties" : { + "dataset" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDatasetToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" - }, - "metrics": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "user": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "userGroup": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "userDataFilter" - ], - "example": "userDataFilter", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "fact" ], + "example" : "fact", + "type" : "string" } }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiUserDataFilterOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOut" + "JsonApiFactOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiFactOut" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiDatasetOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserDataFilterOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiUserOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiFactOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" - } - ] + "required" : [ "data" ], + "type" : "object" }, - "JsonApiUserDataFilterOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutWithLinks" + "JsonApiFactOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiFactOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiDatasetOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiUserDataFilterOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiUserDataFilterOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "JsonApiFactOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiFactOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] }, - "JsonApiUserDataFilterPatch": { - "description": "JSON:API representation of patching userDataFilter entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "description": { - "maxLength": 10000, - "type": "string" + "JsonApiFactPatch" : { + "description" : "JSON:API representation of patching fact entity.", + "properties" : { + "attributes" : { + "properties" : { + "description" : { + "maxLength" : 10000, + "type" : "string" }, - "maql": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" + "tags" : { + "items" : { + "type" : "string" }, - "type": "array" + "type" : "array" }, - "title": { - "maxLength": 255, - "type": "string" + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "relationships": { - "properties": { - "user": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" + "type" : { + "description" : "Object type", + "enum" : [ "fact" ], + "example" : "fact", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiFactPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiFactPatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiFactToManyLinkage" : { + "description" : "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items" : { + "$ref" : "#/components/schemas/JsonApiFactLinkage" + }, + "type" : "array" + }, + "JsonApiFactToOneLinkage" : { + "description" : "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiFactLinkage" + } ] + }, + "JsonApiFilterContextIn" : { + "description" : "JSON:API representation of filterContext entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" }, - "userGroup": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "userDataFilter" - ], - "example": "userDataFilter", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiUserDataFilterPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserDataFilterPostOptionalId": { - "description": "JSON:API representation of userDataFilter entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "maql": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "maql" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "user": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" - } + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { + "identifier" : { + "id" : "label.leaf", + "type" : "label" + }, + "someBoolProp" : false }, - "required": [ - "data" - ], - "type": "object" + "type" : "object" }, - "userGroup": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" - } + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" }, - "required": [ - "data" - ], - "type": "object" + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "required" : [ "content" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "type": { - "description": "Object type", - "enum": [ - "userDataFilter" - ], - "example": "userDataFilter", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "filterContext" ], + "example" : "filterContext", + "type" : "string" } }, - "required": [ - "attributes", - "type" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiUserDataFilterPostOptionalIdDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalId" + "JsonApiFilterContextInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiFilterContextIn" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiUserGroupIn": { - "description": "JSON:API representation of userGroup entity.", - "properties": { - "attributes": { - "properties": { - "name": { - "maxLength": 255, - "type": "string" + "JsonApiFilterContextLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "filterContext" ], + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiFilterContextOut" : { + "description" : "JSON:API representation of filterContext entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { + "identifier" : { + "id" : "label.leaf", + "type" : "label" + }, + "someBoolProp" : false + }, + "type" : "object" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "required" : [ "content" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" + }, + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" + } + }, + "required" : [ "originId", "originType" ], + "type" : "object" + } + }, + "type" : "object" }, - "relationships": { - "properties": { - "parents": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + "relationships" : { + "properties" : { + "attributes" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAttributeToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "datasets" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDatasetToManyLinkage" } }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "userGroup" - ], - "example": "userGroup", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiUserGroupInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserGroupLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "userGroup" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiUserGroupOut": { - "description": "JSON:API representation of userGroup entity.", - "properties": { - "attributes": { - "properties": { - "name": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "parents": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + "required" : [ "data" ], + "type" : "object" + }, + "labels" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiLabelToManyLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "userGroup" - ], - "example": "userGroup", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "filterContext" ], + "example" : "filterContext", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiUserGroupOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupOut" + "JsonApiFilterContextOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiFilterContextOut" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiFilterContextOutIncludes" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiFilterContextOutIncludes" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiAttributeOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiDatasetOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiLabelOutWithLinks" + } ] }, - "JsonApiUserGroupOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "JsonApiFilterContextOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiFilterContextOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiFilterContextOutIncludes" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiUserGroupOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiUserGroupOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "JsonApiFilterContextOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiFilterContextOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] }, - "JsonApiUserGroupPatch": { - "description": "JSON:API representation of patching userGroup entity.", - "properties": { - "attributes": { - "properties": { - "name": { - "maxLength": 255, - "type": "string" + "JsonApiFilterContextPatch" : { + "description" : "JSON:API representation of patching filterContext entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { + "identifier" : { + "id" : "label.leaf", + "type" : "label" + }, + "someBoolProp" : false + }, + "type" : "object" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "relationships": { - "properties": { - "parents": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" - } + "type" : { + "description" : "Object type", + "enum" : [ "filterContext" ], + "example" : "filterContext", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiFilterContextPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiFilterContextPatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiFilterContextPostOptionalId" : { + "description" : "JSON:API representation of filterContext entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { + "identifier" : { + "id" : "label.leaf", + "type" : "label" + }, + "someBoolProp" : false }, - "required": [ - "data" - ], - "type": "object" + "type" : "object" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "userGroup" - ], - "example": "userGroup", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiUserGroupPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserGroupToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiUserGroupLinkage" - }, - "type": "array" - }, - "JsonApiUserGroupToOneLinkage": { - "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "nullable": true, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiUserGroupLinkage" + "required" : [ "content" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "filterContext" ], + "example" : "filterContext", + "type" : "string" } - ] + }, + "required" : [ "attributes", "type" ], + "type" : "object" }, - "JsonApiUserIdentifierLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "userIdentifier" - ], - "type": "string" + "JsonApiFilterContextPostOptionalIdDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiFilterContextPostOptionalId" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiFilterContextToManyLinkage" : { + "description" : "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items" : { + "$ref" : "#/components/schemas/JsonApiFilterContextLinkage" + }, + "type" : "array" }, - "JsonApiUserIdentifierOut": { - "description": "JSON:API representation of userIdentifier entity.", - "properties": { - "attributes": { - "properties": { - "email": { - "maxLength": 255, - "type": "string" + "JsonApiFilterViewIn" : { + "description" : "JSON:API representation of filterView entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "description" : "The respective filter context.", + "type" : "object" }, - "firstname": { - "maxLength": 255, - "type": "string" + "description" : { + "maxLength" : 10000, + "type" : "string" }, - "lastname": { - "maxLength": 255, - "type": "string" + "isDefault" : { + "description" : "Indicator whether the filter view should by applied by default.", + "type" : "boolean" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "required" : [ "content", "title" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "relationships" : { + "properties" : { + "analyticalDashboard" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "user" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "userIdentifier" - ], - "example": "userIdentifier", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "filterView" ], + "example" : "filterView", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiUserIdentifierOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserIdentifierOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserIdentifierOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiUserIdentifierOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiUserIdentifierToOneLinkage": { - "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "nullable": true, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiUserIdentifierLinkage" + "JsonApiFilterViewInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiFilterViewIn" } - ] - }, - "JsonApiUserIn": { - "description": "JSON:API representation of user entity.", - "properties": { - "attributes": { - "properties": { - "authenticationId": { - "maxLength": 255, - "type": "string" + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiFilterViewOut" : { + "description" : "JSON:API representation of filterView entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "description" : "The respective filter context.", + "type" : "object" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" }, - "email": { - "maxLength": 255, - "type": "string" + "isDefault" : { + "description" : "Indicator whether the filter view should by applied by default.", + "type" : "boolean" }, - "firstname": { - "maxLength": 255, - "type": "string" + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" }, - "lastname": { - "maxLength": 255, - "type": "string" - } + "title" : { + "maxLength" : 255, + "type" : "string" + } }, - "type": "object" + "required" : [ "content", "title" ], + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "relationships": { - "properties": { - "userGroups": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + "relationships" : { + "properties" : { + "analyticalDashboard" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "user" - ], - "example": "user", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiUserInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "user" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiUserOut": { - "description": "JSON:API representation of user entity.", - "properties": { - "attributes": { - "properties": { - "authenticationId": { - "maxLength": 255, - "type": "string" - }, - "email": { - "maxLength": 255, - "type": "string" - }, - "firstname": { - "maxLength": 255, - "type": "string" - }, - "lastname": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "userGroups": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + "required" : [ "data" ], + "type" : "object" + }, + "user" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "user" - ], - "example": "user", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "filterView" ], + "example" : "filterView", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiUserOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserOut" + "JsonApiFilterViewOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiFilterViewOut" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiFilterViewOutIncludes" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiFilterViewOutIncludes" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiUserOutWithLinks" + } ] }, - "JsonApiUserOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiUserOutWithLinks" + "JsonApiFilterViewOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiFilterViewOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiFilterViewOutIncludes" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiUserOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiUserOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "JsonApiFilterViewOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiFilterViewOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] }, - "JsonApiUserPatch": { - "description": "JSON:API representation of patching user entity.", - "properties": { - "attributes": { - "properties": { - "authenticationId": { - "maxLength": 255, - "type": "string" + "JsonApiFilterViewPatch" : { + "description" : "JSON:API representation of patching filterView entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "description" : "The respective filter context.", + "type" : "object" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" }, - "email": { - "maxLength": 255, - "type": "string" + "isDefault" : { + "description" : "Indicator whether the filter view should by applied by default.", + "type" : "boolean" }, - "firstname": { - "maxLength": 255, - "type": "string" + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" }, - "lastname": { - "maxLength": 255, - "type": "string" + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "relationships": { - "properties": { - "userGroups": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + "relationships" : { + "properties" : { + "analyticalDashboard" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "user" - ], - "example": "user", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiUserPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserSettingIn": { - "description": "JSON:API representation of userSetting entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_ENDPOINT", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "SORT_CASE_SENSITIVE", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS" - ], - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "userSetting" - ], - "example": "userSetting", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiUserSettingInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserSettingIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserSettingOut": { - "description": "JSON:API representation of userSetting entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_ENDPOINT", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "SORT_CASE_SENSITIVE", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS" - ], - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "userSetting" - ], - "example": "userSetting", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiUserSettingOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserSettingOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserSettingOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiUserSettingOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserSettingOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiUserSettingOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiUserToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiUserLinkage" - }, - "type": "array" - }, - "JsonApiUserToOneLinkage": { - "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "nullable": true, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiUserLinkage" - } - ] - }, - "JsonApiVisualizationObjectIn": { - "description": "JSON:API representation of visualizationObject entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" + "required" : [ "data" ], + "type" : "object" }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - }, - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "isHidden": { - "type": "boolean" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "visualizationObject" - ], - "example": "visualizationObject", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiVisualizationObjectInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiVisualizationObjectLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "visualizationObject" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiVisualizationObjectOut": { - "description": "JSON:API representation of visualizationObject entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false + "user" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "filterView" ], + "example" : "filterView", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiFilterViewPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiFilterViewPatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiIdentityProviderIn" : { + "description" : "JSON:API representation of identityProvider entity.", + "properties" : { + "attributes" : { + "properties" : { + "customClaimMapping" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", + "maxLength" : 10000, + "type" : "object" + }, + "identifiers" : { + "description" : "List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.", + "example" : [ "gooddata.com" ], + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "idpType" : { + "description" : "Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", + "enum" : [ "MANAGED_IDP", "FIM_IDP", "DEX_IDP", "CUSTOM_IDP" ], + "type" : "string" + }, + "oauthClientId" : { + "description" : "The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", + "maxLength" : 255, + "type" : "string" + }, + "oauthClientSecret" : { + "description" : "The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.", + "maxLength" : 255, + "type" : "string" + }, + "oauthCustomAuthAttributes" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength" : 10000, + "type" : "object" + }, + "oauthCustomScopes" : { + "description" : "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", + "items" : { + "maxLength" : 255, + "type" : "string" }, - "type": "object" + "nullable" : true, + "type" : "array" + }, + "oauthIssuerId" : { + "description" : "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", + "example" : "myOidcProvider", + "maxLength" : 255, + "type" : "string" }, - "createdAt": { - "format": "date-time", - "type": "string" + "oauthIssuerLocation" : { + "description" : "The location of your OIDC provider. This field is mandatory for OIDC IdP.", + "maxLength" : 255, + "type" : "string" + }, + "oauthSubjectIdClaim" : { + "description" : "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", + "example" : "oid", + "maxLength" : 255, + "type" : "string" + }, + "samlMetadata" : { + "description" : "Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.", + "maxLength" : 15000, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "identityProvider" ], + "example" : "identityProvider", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiIdentityProviderInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiIdentityProviderLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "identityProvider" ], + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiIdentityProviderOut" : { + "description" : "JSON:API representation of identityProvider entity.", + "properties" : { + "attributes" : { + "properties" : { + "customClaimMapping" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", + "maxLength" : 10000, + "type" : "object" + }, + "identifiers" : { + "description" : "List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.", + "example" : [ "gooddata.com" ], + "items" : { + "type" : "string" + }, + "type" : "array" }, - "description": { - "maxLength": 10000, - "type": "string" + "idpType" : { + "description" : "Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", + "enum" : [ "MANAGED_IDP", "FIM_IDP", "DEX_IDP", "CUSTOM_IDP" ], + "type" : "string" }, - "isHidden": { - "type": "boolean" + "oauthClientId" : { + "description" : "The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", + "maxLength" : 255, + "type" : "string" }, - "modifiedAt": { - "format": "date-time", - "type": "string" + "oauthCustomAuthAttributes" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength" : 10000, + "type" : "object" }, - "tags": { - "items": { - "type": "string" + "oauthCustomScopes" : { + "description" : "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", + "items" : { + "maxLength" : 255, + "type" : "string" }, - "type": "array" + "nullable" : true, + "type" : "array" + }, + "oauthIssuerId" : { + "description" : "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", + "example" : "myOidcProvider", + "maxLength" : 255, + "type" : "string" }, - "title": { - "maxLength": 255, - "type": "string" + "oauthIssuerLocation" : { + "description" : "The location of your OIDC provider. This field is mandatory for OIDC IdP.", + "maxLength" : 255, + "type" : "string" + }, + "oauthSubjectIdClaim" : { + "description" : "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", + "example" : "oid", + "maxLength" : 255, + "type" : "string" } }, - "required": [ - "content" - ], - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" - }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" - } - }, - "required": [ - "originId", - "originType" - ], - "type": "object" + "type" : { + "description" : "Object type", + "enum" : [ "identityProvider" ], + "example" : "identityProvider", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiIdentityProviderOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderOut" + }, + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiIdentityProviderOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } + }, + "type" : "object" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiIdentityProviderOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiIdentityProviderOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiIdentityProviderPatch" : { + "description" : "JSON:API representation of patching identityProvider entity.", + "properties" : { + "attributes" : { + "properties" : { + "customClaimMapping" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.", + "maxLength" : 10000, + "type" : "object" + }, + "identifiers" : { + "description" : "List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.", + "example" : [ "gooddata.com" ], + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "idpType" : { + "description" : "Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", + "enum" : [ "MANAGED_IDP", "FIM_IDP", "DEX_IDP", "CUSTOM_IDP" ], + "type" : "string" + }, + "oauthClientId" : { + "description" : "The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", + "maxLength" : 255, + "type" : "string" + }, + "oauthClientSecret" : { + "description" : "The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.", + "maxLength" : 255, + "type" : "string" + }, + "oauthCustomAuthAttributes" : { + "additionalProperties" : { + "type" : "string" + }, + "description" : "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", + "maxLength" : 10000, + "type" : "object" + }, + "oauthCustomScopes" : { + "description" : "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", + "items" : { + "maxLength" : 255, + "type" : "string" + }, + "nullable" : true, + "type" : "array" + }, + "oauthIssuerId" : { + "description" : "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", + "example" : "myOidcProvider", + "maxLength" : 255, + "type" : "string" + }, + "oauthIssuerLocation" : { + "description" : "The location of your OIDC provider. This field is mandatory for OIDC IdP.", + "maxLength" : 255, + "type" : "string" + }, + "oauthSubjectIdClaim" : { + "description" : "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", + "example" : "oid", + "maxLength" : 255, + "type" : "string" + }, + "samlMetadata" : { + "description" : "Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.", + "maxLength" : 15000, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "identityProvider" ], + "example" : "identityProvider", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiIdentityProviderPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderPatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiIdentityProviderToOneLinkage" : { + "description" : "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiIdentityProviderLinkage" + } ] + }, + "JsonApiJwkIn" : { + "description" : "JSON:API representation of jwk entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Specification of the cryptographic key", + "example" : { + "alg" : "RS256", + "kyt" : "RSA", + "use" : "sig" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/RsaSpecification" + } ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "relationships": { - "properties": { - "attributes": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "createdBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "jwk" ], + "example" : "jwk", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiJwkInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiJwkIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiJwkOut" : { + "description" : "JSON:API representation of jwk entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Specification of the cryptographic key", + "example" : { + "alg" : "RS256", + "kyt" : "RSA", + "use" : "sig" }, - "required": [ - "data" - ], - "type": "object" - }, - "datasets": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" + "oneOf" : [ { + "$ref" : "#/components/schemas/RsaSpecification" + } ], + "type" : "object" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "jwk" ], + "example" : "jwk", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiJwkOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiJwkOut" + }, + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiJwkOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiJwkOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } + }, + "type" : "object" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiJwkOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiJwkOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiJwkPatch" : { + "description" : "JSON:API representation of patching jwk entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Specification of the cryptographic key", + "example" : { + "alg" : "RS256", + "kyt" : "RSA", + "use" : "sig" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/RsaSpecification" + } ], + "type" : "object" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "jwk" ], + "example" : "jwk", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiJwkPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiJwkPatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiKnowledgeRecommendationIn" : { + "description" : "JSON:API representation of knowledgeRecommendation entity.", + "properties" : { + "attributes" : { + "properties" : { + "analyticalDashboardTitle" : { + "description" : "Human-readable title of the analytical dashboard (denormalized for display)", + "example" : "Portfolio Health Insights", + "maxLength" : 255, + "type" : "string" + }, + "analyzedPeriod" : { + "description" : "Analyzed time period (e.g., '2023-07' or 'July 2023')", + "example" : "2023-07", + "maxLength" : 255, + "type" : "string" + }, + "analyzedValue" : { + "description" : "Metric value in the analyzed period (the observed value that triggered the anomaly)", + "example" : 2.6E9 + }, + "areRelationsValid" : { + "type" : "boolean" + }, + "comparisonType" : { + "description" : "Time period for comparison", + "enum" : [ "MONTH", "QUARTER", "YEAR" ], + "example" : "MONTH", + "type" : "string" + }, + "confidence" : { + "description" : "Confidence score (0.0 to 1.0)", + "example" : 0.62 + }, + "description" : { + "description" : "Description of the recommendation", + "maxLength" : 10000, + "type" : "string" + }, + "direction" : { + "description" : "Direction of the metric change", + "enum" : [ "INCREASED", "DECREASED" ], + "example" : "DECREASED", + "type" : "string" + }, + "metricTitle" : { + "description" : "Human-readable title of the metric (denormalized for display)", + "example" : "Revenue", + "maxLength" : 255, + "type" : "string" + }, + "recommendations" : { + "description" : "Structured recommendations data as JSON", + "example" : "{\"summary\": \"...\", \"recommendations\": [...], \"key_metrics\": [...]}", + "type" : "object" + }, + "referencePeriod" : { + "description" : "Reference time period for comparison (e.g., '2023-06' or 'Jun 2023')", + "example" : "2023-06", + "maxLength" : 255, + "type" : "string" + }, + "referenceValue" : { + "description" : "Metric value in the reference period", + "example" : 2.4E9 + }, + "sourceCount" : { + "description" : "Number of source documents used for generation", + "example" : 2, + "format" : "int32", + "type" : "integer" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "description" : "Human-readable title for the recommendation, e.g. 'Revenue decreased vs last month'", + "maxLength" : 255, + "type" : "string" + }, + "widgetId" : { + "description" : "ID of the widget where the anomaly was detected", + "example" : "widget-123", + "maxLength" : 255, + "type" : "string" + }, + "widgetName" : { + "description" : "Name of the widget where the anomaly was detected", + "example" : "Revenue Trend", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "comparisonType", "direction", "title" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "analyticalDashboard" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "facts": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFactToManyLinkage" + "metric" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiMetricToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" - }, - "labels": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" + "required" : [ "data" ], + "type" : "object" + } + }, + "required" : [ "metric" ], + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "knowledgeRecommendation" ], + "example" : "knowledgeRecommendation", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "relationships", "type" ], + "type" : "object" + }, + "JsonApiKnowledgeRecommendationInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiKnowledgeRecommendationOut" : { + "description" : "JSON:API representation of knowledgeRecommendation entity.", + "properties" : { + "attributes" : { + "properties" : { + "analyticalDashboardTitle" : { + "description" : "Human-readable title of the analytical dashboard (denormalized for display)", + "example" : "Portfolio Health Insights", + "maxLength" : 255, + "type" : "string" + }, + "analyzedPeriod" : { + "description" : "Analyzed time period (e.g., '2023-07' or 'July 2023')", + "example" : "2023-07", + "maxLength" : 255, + "type" : "string" + }, + "analyzedValue" : { + "description" : "Metric value in the analyzed period (the observed value that triggered the anomaly)", + "example" : 2.6E9 + }, + "areRelationsValid" : { + "type" : "boolean" + }, + "comparisonType" : { + "description" : "Time period for comparison", + "enum" : [ "MONTH", "QUARTER", "YEAR" ], + "example" : "MONTH", + "type" : "string" + }, + "confidence" : { + "description" : "Confidence score (0.0 to 1.0)", + "example" : 0.62 + }, + "createdAt" : { + "format" : "date-time", + "type" : "string" + }, + "description" : { + "description" : "Description of the recommendation", + "maxLength" : 10000, + "type" : "string" + }, + "direction" : { + "description" : "Direction of the metric change", + "enum" : [ "INCREASED", "DECREASED" ], + "example" : "DECREASED", + "type" : "string" + }, + "metricTitle" : { + "description" : "Human-readable title of the metric (denormalized for display)", + "example" : "Revenue", + "maxLength" : 255, + "type" : "string" + }, + "recommendations" : { + "description" : "Structured recommendations data as JSON", + "example" : "{\"summary\": \"...\", \"recommendations\": [...], \"key_metrics\": [...]}", + "type" : "object" + }, + "referencePeriod" : { + "description" : "Reference time period for comparison (e.g., '2023-06' or 'Jun 2023')", + "example" : "2023-06", + "maxLength" : 255, + "type" : "string" + }, + "referenceValue" : { + "description" : "Metric value in the reference period", + "example" : 2.4E9 + }, + "sourceCount" : { + "description" : "Number of source documents used for generation", + "example" : 2, + "format" : "int32", + "type" : "integer" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "description" : "Human-readable title for the recommendation, e.g. 'Revenue decreased vs last month'", + "maxLength" : 255, + "type" : "string" + }, + "widgetId" : { + "description" : "ID of the widget where the anomaly was detected", + "example" : "widget-123", + "maxLength" : 255, + "type" : "string" + }, + "widgetName" : { + "description" : "Name of the widget where the anomaly was detected", + "example" : "Revenue Trend", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "comparisonType", "direction", "title" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" + }, + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" } }, - "required": [ - "data" - ], - "type": "object" - }, - "metrics": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" + "required" : [ "originId", "originType" ], + "type" : "object" + } + }, + "type" : "object" + }, + "relationships" : { + "properties" : { + "analyticalDashboard" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "modifiedBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + "metric" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiMetricToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "visualizationObject" - ], - "example": "visualizationObject", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "knowledgeRecommendation" ], + "example" : "knowledgeRecommendation", + "type" : "string" } }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiVisualizationObjectOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" + "JsonApiKnowledgeRecommendationOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationOut" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationOutIncludes" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiVisualizationObjectOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "JsonApiKnowledgeRecommendationOutIncludes" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiMetricOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" + } ] + }, + "JsonApiKnowledgeRecommendationOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true + }, + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationOutIncludes" + }, + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } + }, + "type" : "object" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiKnowledgeRecommendationOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiKnowledgeRecommendationPatch" : { + "description" : "JSON:API representation of patching knowledgeRecommendation entity.", + "properties" : { + "attributes" : { + "properties" : { + "analyticalDashboardTitle" : { + "description" : "Human-readable title of the analytical dashboard (denormalized for display)", + "example" : "Portfolio Health Insights", + "maxLength" : 255, + "type" : "string" + }, + "analyzedPeriod" : { + "description" : "Analyzed time period (e.g., '2023-07' or 'July 2023')", + "example" : "2023-07", + "maxLength" : 255, + "type" : "string" + }, + "analyzedValue" : { + "description" : "Metric value in the analyzed period (the observed value that triggered the anomaly)", + "example" : 2.6E9 + }, + "areRelationsValid" : { + "type" : "boolean" + }, + "comparisonType" : { + "description" : "Time period for comparison", + "enum" : [ "MONTH", "QUARTER", "YEAR" ], + "example" : "MONTH", + "type" : "string" + }, + "confidence" : { + "description" : "Confidence score (0.0 to 1.0)", + "example" : 0.62 + }, + "description" : { + "description" : "Description of the recommendation", + "maxLength" : 10000, + "type" : "string" + }, + "direction" : { + "description" : "Direction of the metric change", + "enum" : [ "INCREASED", "DECREASED" ], + "example" : "DECREASED", + "type" : "string" + }, + "metricTitle" : { + "description" : "Human-readable title of the metric (denormalized for display)", + "example" : "Revenue", + "maxLength" : 255, + "type" : "string" + }, + "recommendations" : { + "description" : "Structured recommendations data as JSON", + "example" : "{\"summary\": \"...\", \"recommendations\": [...], \"key_metrics\": [...]}", + "type" : "object" + }, + "referencePeriod" : { + "description" : "Reference time period for comparison (e.g., '2023-06' or 'Jun 2023')", + "example" : "2023-06", + "maxLength" : 255, + "type" : "string" + }, + "referenceValue" : { + "description" : "Metric value in the reference period", + "example" : 2.4E9 + }, + "sourceCount" : { + "description" : "Number of source documents used for generation", + "example" : 2, + "format" : "int32", + "type" : "integer" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "description" : "Human-readable title for the recommendation, e.g. 'Revenue decreased vs last month'", + "maxLength" : 255, + "type" : "string" + }, + "widgetId" : { + "description" : "ID of the widget where the anomaly was detected", + "example" : "widget-123", + "maxLength" : 255, + "type" : "string" + }, + "widgetName" : { + "description" : "Name of the widget where the anomaly was detected", + "example" : "Revenue Trend", + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "analyticalDashboard" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "metric" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiMetricToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "knowledgeRecommendation" ], + "example" : "knowledgeRecommendation", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "relationships", "type" ], + "type" : "object" + }, + "JsonApiKnowledgeRecommendationPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationPatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiKnowledgeRecommendationPostOptionalId" : { + "description" : "JSON:API representation of knowledgeRecommendation entity.", + "properties" : { + "attributes" : { + "properties" : { + "analyticalDashboardTitle" : { + "description" : "Human-readable title of the analytical dashboard (denormalized for display)", + "example" : "Portfolio Health Insights", + "maxLength" : 255, + "type" : "string" + }, + "analyzedPeriod" : { + "description" : "Analyzed time period (e.g., '2023-07' or 'July 2023')", + "example" : "2023-07", + "maxLength" : 255, + "type" : "string" + }, + "analyzedValue" : { + "description" : "Metric value in the analyzed period (the observed value that triggered the anomaly)", + "example" : 2.6E9 + }, + "areRelationsValid" : { + "type" : "boolean" + }, + "comparisonType" : { + "description" : "Time period for comparison", + "enum" : [ "MONTH", "QUARTER", "YEAR" ], + "example" : "MONTH", + "type" : "string" + }, + "confidence" : { + "description" : "Confidence score (0.0 to 1.0)", + "example" : 0.62 + }, + "description" : { + "description" : "Description of the recommendation", + "maxLength" : 10000, + "type" : "string" + }, + "direction" : { + "description" : "Direction of the metric change", + "enum" : [ "INCREASED", "DECREASED" ], + "example" : "DECREASED", + "type" : "string" + }, + "metricTitle" : { + "description" : "Human-readable title of the metric (denormalized for display)", + "example" : "Revenue", + "maxLength" : 255, + "type" : "string" + }, + "recommendations" : { + "description" : "Structured recommendations data as JSON", + "example" : "{\"summary\": \"...\", \"recommendations\": [...], \"key_metrics\": [...]}", + "type" : "object" + }, + "referencePeriod" : { + "description" : "Reference time period for comparison (e.g., '2023-06' or 'Jun 2023')", + "example" : "2023-06", + "maxLength" : 255, + "type" : "string" + }, + "referenceValue" : { + "description" : "Metric value in the reference period", + "example" : 2.4E9 + }, + "sourceCount" : { + "description" : "Number of source documents used for generation", + "example" : 2, + "format" : "int32", + "type" : "integer" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "description" : "Human-readable title for the recommendation, e.g. 'Revenue decreased vs last month'", + "maxLength" : 255, + "type" : "string" + }, + "widgetId" : { + "description" : "ID of the widget where the anomaly was detected", + "example" : "widget-123", + "maxLength" : 255, + "type" : "string" + }, + "widgetName" : { + "description" : "Name of the widget where the anomaly was detected", + "example" : "Revenue Trend", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "comparisonType", "direction", "title" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "analyticalDashboard" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "metric" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiMetricToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "required" : [ "metric" ], + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "knowledgeRecommendation" ], + "example" : "knowledgeRecommendation", + "type" : "string" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "attributes", "relationships", "type" ], + "type" : "object" }, - "JsonApiVisualizationObjectOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiVisualizationObjectPatch": { - "description": "JSON:API representation of patching visualizationObject entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - }, - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "isHidden": { - "type": "boolean" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "visualizationObject" - ], - "example": "visualizationObject", - "type": "string" + "JsonApiKnowledgeRecommendationPostOptionalIdDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalId" } }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiVisualizationObjectPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPatch" + "JsonApiLabelLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "label" ], + "type" : "string" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiVisualizationObjectPostOptionalId": { - "description": "JSON:API representation of visualizationObject entity.", - "properties": { - "attributes": { - "properties": { - "areRelationsValid": { - "type": "boolean" + "JsonApiLabelOut" : { + "description" : "JSON:API representation of label entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - }, - "type": "object" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "isHidden": { - "type": "boolean" - }, - "tags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "content" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "visualizationObject" - ], - "example": "visualizationObject", - "type": "string" - } - }, - "required": [ - "attributes", - "type" - ], - "type": "object" - }, - "JsonApiVisualizationObjectPostOptionalIdDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalId" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiVisualizationObjectToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectLinkage" - }, - "type": "array" - }, - "JsonApiVisualizationObjectToOneLinkage": { - "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "nullable": true, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiVisualizationObjectLinkage" - } - ] - }, - "JsonApiWorkspaceAutomationOut": { - "description": "JSON:API representation of workspaceAutomation entity.", - "properties": { - "attributes": { - "properties": { - "alert": { - "properties": { - "condition": { - "$ref": "#/components/schemas/AlertCondition" - }, - "execution": { - "$ref": "#/components/schemas/AlertAfm" - }, - "trigger": { - "default": "ALWAYS", - "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\n", - "enum": [ - "ALWAYS", - "ONCE" - ], - "type": "string" + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "geoAreaConfig" : { + "description" : "Configuration specific to geo area labels.", + "properties" : { + "collection" : { + "$ref" : "#/components/schemas/GeoCollectionIdentifier" } }, - "required": [ - "condition", - "execution" - ], - "type": "object" + "required" : [ "collection" ], + "type" : "object" }, - "areRelationsValid": { - "type": "boolean" + "isHidden" : { + "type" : "boolean" }, - "createdAt": { - "format": "date-time", - "type": "string" + "isNullable" : { + "type" : "boolean" }, - "dashboardTabularExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/DashboardTabularExportRequestV2" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "details": { - "description": "Additional details to be included in the automated message.", - "maxLength": 10000, - "type": "object" - }, - "evaluationMode": { - "description": "Specify automation evaluation mode.", - "enum": [ - "SHARED", - "PER_RECIPIENT" - ], - "type": "string" - }, - "externalRecipients": { - "description": "External recipients of the automation action results.", - "items": { - "properties": { - "email": { - "description": "E-mail address to send notifications from.", - "format": "email", - "type": "string" - } - }, - "required": [ - "email" - ], - "type": "object" - }, - "type": "array" - }, - "imageExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/ImageExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "metadata": { - "additionalProperties": true, - "description": "Additional information for the automation.", - "maxLength": 250000, - "nullable": true, - "properties": { - "visibleFilters": { - "items": { - "$ref": "#/components/schemas/VisibleFilter" - }, - "type": "array" - }, - "widget": { - "type": "string" - } - }, - "type": "object" + "locale" : { + "type" : "string" }, - "modifiedAt": { - "format": "date-time", - "type": "string" + "nullValue" : { + "type" : "string" }, - "rawExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/RawExportAutomationRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "schedule": { - "properties": { - "cron": { - "description": "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", - "example": "0 */30 9-17 ? * MON-FRI", - "maxLength": 255, - "type": "string" - }, - "cronDescription": { - "description": "Human-readable description of the cron expression.", - "readOnly": true, - "type": "string" - }, - "firstRun": { - "description": "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", - "example": "2025-01-01T12:00:00Z", - "format": "date-time", - "type": "string" - }, - "timezone": { - "description": "Timezone in which the schedule is defined.", - "example": "Europe/Prague", - "maxLength": 255, - "type": "string" - } - }, - "required": [ - "cron", - "timezone" - ], - "type": "object" - }, - "slidesExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/SlidesExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" - }, - "state": { - "description": "Current state of the automation.", - "enum": [ - "ACTIVE", - "PAUSED" - ], - "type": "string" - }, - "tabularExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/TabularExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" + "primary" : { + "type" : "boolean" + }, + "sourceColumn" : { + "maxLength" : 255, + "type" : "string" + }, + "sourceColumnDataType" : { + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "type" : "string" }, - "tags": { - "items": { - "type": "string" + "tags" : { + "items" : { + "type" : "string" }, - "type": "array" + "type" : "array" }, - "title": { - "maxLength": 255, - "type": "string" + "title" : { + "maxLength" : 255, + "type" : "string" }, - "visualExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/VisualExportRequest" + "translations" : { + "items" : { + "properties" : { + "locale" : { + "type" : "string" + }, + "sourceColumn" : { + "type" : "string" } }, - "required": [ - "requestPayload" - ], - "type": "object" + "required" : [ "locale", "sourceColumn" ], + "type" : "object" }, - "type": "array" + "type" : "array" + }, + "valueType" : { + "enum" : [ "TEXT", "HYPERLINK", "GEO", "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", "IMAGE" ], + "type" : "string" } }, - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "relationships": { - "properties": { - "analyticalDashboard": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "automationResults": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAutomationResultToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "createdBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "exportDefinitions": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiExportDefinitionToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "modifiedBy": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "notificationChannel": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiNotificationChannelToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "recipients": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToManyLinkage" + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" + }, + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" } }, - "required": [ - "data" - ], - "type": "object" - }, - "workspace": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + "required" : [ "originId", "originType" ], + "type" : "object" + } + }, + "type" : "object" + }, + "relationships" : { + "properties" : { + "attribute" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAttributeToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "workspaceAutomation" - ], - "example": "workspaceAutomation", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "label" ], + "example" : "label", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiWorkspaceAutomationOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + "JsonApiLabelOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiLabelOut" }, - { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiUserOutWithLinks" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiAttributeOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true }, - { - "$ref": "#/components/schemas/JsonApiAutomationResultOutWithLinks" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } - ] + }, + "required" : [ "data" ], + "type" : "object" }, - "JsonApiWorkspaceAutomationOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutWithLinks" + "JsonApiLabelOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiLabelOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutIncludes" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiAttributeOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiLabelOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiLabelOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] }, - "JsonApiWorkspaceAutomationOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOut" + "JsonApiLabelPatch" : { + "description" : "JSON:API representation of patching label entity.", + "properties" : { + "attributes" : { + "properties" : { + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" + "type" : { + "description" : "Object type", + "enum" : [ "label" ], + "example" : "label", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiLabelPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiLabelPatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiLabelToManyLinkage" : { + "description" : "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items" : { + "$ref" : "#/components/schemas/JsonApiLabelLinkage" + }, + "type" : "array" + }, + "JsonApiLabelToOneLinkage" : { + "description" : "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiLabelLinkage" + } ] + }, + "JsonApiLlmEndpointIn" : { + "description" : "JSON:API representation of llmEndpoint entity.", + "properties" : { + "attributes" : { + "properties" : { + "baseUrl" : { + "description" : "Custom LLM endpoint.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "llmModel" : { + "description" : "LLM Model. We provide a default model for each provider, but you can override it here.", + "maxLength" : 255, + "type" : "string" + }, + "llmOrganization" : { + "description" : "Organization in LLM provider.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "provider" : { + "description" : "LLM Provider.", + "enum" : [ "OPENAI", "AZURE_OPENAI" ], + "type" : "string" + }, + "title" : { + "description" : "User-facing title of the LLM Provider.", + "maxLength" : 255, + "type" : "string" + }, + "token" : { + "description" : "The token to use to connect to the LLM provider.", + "maxLength" : 10000, + "type" : "string" + } + }, + "required" : [ "title", "token" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "llmEndpoint" ], + "example" : "llmEndpoint", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiLlmEndpointInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiLlmEndpointOut" : { + "description" : "JSON:API representation of llmEndpoint entity.", + "properties" : { + "attributes" : { + "properties" : { + "baseUrl" : { + "description" : "Custom LLM endpoint.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "llmModel" : { + "description" : "LLM Model. We provide a default model for each provider, but you can override it here.", + "maxLength" : 255, + "type" : "string" + }, + "llmOrganization" : { + "description" : "Organization in LLM provider.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "provider" : { + "description" : "LLM Provider.", + "enum" : [ "OPENAI", "AZURE_OPENAI" ], + "type" : "string" + }, + "title" : { + "description" : "User-facing title of the LLM Provider.", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "title" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "llmEndpoint" ], + "example" : "llmEndpoint", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiLlmEndpointOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointOut" + }, + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } - ] + }, + "required" : [ "data" ], + "type" : "object" }, - "JsonApiWorkspaceDataFilterIn": { - "description": "JSON:API representation of workspaceDataFilter entity.", - "properties": { - "attributes": { - "properties": { - "columnName": { - "maxLength": 255, - "type": "string" + "JsonApiLlmEndpointOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } + }, + "type" : "object" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiLlmEndpointOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiLlmEndpointOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiLlmEndpointPatch" : { + "description" : "JSON:API representation of patching llmEndpoint entity.", + "properties" : { + "attributes" : { + "properties" : { + "baseUrl" : { + "description" : "Custom LLM endpoint.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" }, - "description": { - "maxLength": 10000, - "type": "string" + "llmModel" : { + "description" : "LLM Model. We provide a default model for each provider, but you can override it here.", + "maxLength" : 255, + "type" : "string" }, - "title": { - "maxLength": 255, - "type": "string" + "llmOrganization" : { + "description" : "Organization in LLM provider.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "provider" : { + "description" : "LLM Provider.", + "enum" : [ "OPENAI", "AZURE_OPENAI" ], + "type" : "string" + }, + "title" : { + "description" : "User-facing title of the LLM Provider.", + "maxLength" : 255, + "type" : "string" + }, + "token" : { + "description" : "The token to use to connect to the LLM provider.", + "maxLength" : 10000, + "type" : "string" } }, - "type": "object" + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "relationships": { - "properties": { - "filterSettings": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "workspaceDataFilter" - ], - "example": "workspaceDataFilter", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiWorkspaceDataFilterInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiWorkspaceDataFilterLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "workspaceDataFilter" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiWorkspaceDataFilterOut": { - "description": "JSON:API representation of workspaceDataFilter entity.", - "properties": { - "attributes": { - "properties": { - "columnName": { - "maxLength": 255, - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "llmEndpoint" ], + "example" : "llmEndpoint", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiLlmEndpointPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointPatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiMemoryItemIn" : { + "description" : "JSON:API representation of memoryItem entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "instruction" : { + "description" : "The text that will be injected into the system prompt", + "maxLength" : 255, + "type" : "string" + }, + "isDisabled" : { + "description" : "Whether memory item is disabled", + "type" : "boolean" + }, + "keywords" : { + "description" : "Set of unique strings used for semantic similarity filtering", + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "strategy" : { + "description" : "Strategy defining when the memory item should be applied", + "enum" : [ "ALWAYS", "AUTO" ], + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "instruction", "strategy" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "memoryItem" ], + "example" : "memoryItem", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiMemoryItemInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiMemoryItemOut" : { + "description" : "JSON:API representation of memoryItem entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "createdAt" : { + "description" : "Time of the entity creation.", + "format" : "date-time", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "instruction" : { + "description" : "The text that will be injected into the system prompt", + "maxLength" : 255, + "type" : "string" + }, + "isDisabled" : { + "description" : "Whether memory item is disabled", + "type" : "boolean" + }, + "keywords" : { + "description" : "Set of unique strings used for semantic similarity filtering", + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "modifiedAt" : { + "description" : "Time of the last entity modification.", + "format" : "date-time", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "strategy" : { + "description" : "Strategy defining when the memory item should be applied", + "enum" : [ "ALWAYS", "AUTO" ], + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "instruction", "strategy" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" } }, - "required": [ - "originId", - "originType" - ], - "type": "object" + "required" : [ "originId", "originType" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "relationships": { - "properties": { - "filterSettings": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" + "relationships" : { + "properties" : { + "createdBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "modifiedBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "workspaceDataFilter" - ], - "example": "workspaceDataFilter", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "memoryItem" ], + "example" : "memoryItem", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiWorkspaceDataFilterOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" + "JsonApiMemoryItemOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemOut" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiWorkspaceDataFilterOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + "JsonApiMemoryItemOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiWorkspaceDataFilterOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "JsonApiMemoryItemOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiMemoryItemOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] }, - "JsonApiWorkspaceDataFilterPatch": { - "description": "JSON:API representation of patching workspaceDataFilter entity.", - "properties": { - "attributes": { - "properties": { - "columnName": { - "maxLength": 255, - "type": "string" + "JsonApiMemoryItemPatch" : { + "description" : "JSON:API representation of patching memoryItem entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" }, - "description": { - "maxLength": 10000, - "type": "string" + "description" : { + "maxLength" : 10000, + "type" : "string" }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "filterSettings": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" - } + "instruction" : { + "description" : "The text that will be injected into the system prompt", + "maxLength" : 255, + "type" : "string" + }, + "isDisabled" : { + "description" : "Whether memory item is disabled", + "type" : "boolean" + }, + "keywords" : { + "description" : "Set of unique strings used for semantic similarity filtering", + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "strategy" : { + "description" : "Strategy defining when the memory item should be applied", + "enum" : [ "ALWAYS", "AUTO" ], + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" }, - "required": [ - "data" - ], - "type": "object" + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "type": { - "description": "Object type", - "enum": [ - "workspaceDataFilter" - ], - "example": "workspaceDataFilter", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "memoryItem" ], + "example" : "memoryItem", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiWorkspaceDataFilterPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatch" + "JsonApiMemoryItemPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemPatch" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiWorkspaceDataFilterSettingIn": { - "description": "JSON:API representation of workspaceDataFilterSetting entity.", - "properties": { - "attributes": { - "properties": { - "description": { - "maxLength": 10000, - "type": "string" + "JsonApiMemoryItemPostOptionalId" : { + "description" : "JSON:API representation of memoryItem entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "instruction" : { + "description" : "The text that will be injected into the system prompt", + "maxLength" : 255, + "type" : "string" + }, + "isDisabled" : { + "description" : "Whether memory item is disabled", + "type" : "boolean" + }, + "keywords" : { + "description" : "Set of unique strings used for semantic similarity filtering", + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "strategy" : { + "description" : "Strategy defining when the memory item should be applied", + "enum" : [ "ALWAYS", "AUTO" ], + "type" : "string" }, - "filterValues": { - "items": { - "type": "string" + "tags" : { + "items" : { + "type" : "string" }, - "type": "array" + "type" : "array" }, - "title": { - "maxLength": 255, - "type": "string" + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "required" : [ "instruction", "strategy" ], + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "relationships": { - "properties": { - "workspaceDataFilter": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "workspaceDataFilterSetting" - ], - "example": "workspaceDataFilterSetting", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiWorkspaceDataFilterSettingInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiWorkspaceDataFilterSettingLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "workspaceDataFilterSetting" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiWorkspaceDataFilterSettingOut": { - "description": "JSON:API representation of workspaceDataFilterSetting entity.", - "properties": { - "attributes": { - "properties": { - "description": { - "maxLength": 10000, - "type": "string" - }, - "filterValues": { - "items": { - "type": "string" - }, - "type": "array" - }, - "title": { - "maxLength": 255, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "memoryItem" ], + "example" : "memoryItem", + "type" : "string" + } + }, + "required" : [ "attributes", "type" ], + "type" : "object" + }, + "JsonApiMemoryItemPostOptionalIdDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemPostOptionalId" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiMetricIn" : { + "description" : "JSON:API representation of metric entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "properties" : { + "format" : { + "description" : "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", + "maxLength" : 2048, + "nullable" : true, + "type" : "string" + }, + "maql" : { + "maxLength" : 10000, + "type" : "string" }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" + "metricType" : { + "description" : "Categorizes metric semantics (e.g., currency).", + "enum" : [ "UNSPECIFIED", "CURRENCY" ], + "type" : "string" } }, - "required": [ - "originId", - "originType" - ], - "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "workspaceDataFilter": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" - } + "required" : [ "maql" ], + "type" : "object" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "isHidden" : { + "type" : "boolean" + }, + "isHiddenFromKda" : { + "type" : "boolean" + }, + "tags" : { + "items" : { + "type" : "string" }, - "required": [ - "data" - ], - "type": "object" + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "workspaceDataFilterSetting" - ], - "example": "workspaceDataFilterSetting", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiWorkspaceDataFilterSettingOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" + "required" : [ "content" ], + "type" : "object" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" - }, - "type": "array", - "uniqueItems": true + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "type" : { + "description" : "Object type", + "enum" : [ "metric" ], + "example" : "metric", + "type" : "string" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiWorkspaceDataFilterSettingOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" + "JsonApiMetricInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiMetricIn" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiWorkspaceDataFilterSettingOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" + "JsonApiMetricLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" + "type" : { + "enum" : [ "metric" ], + "type" : "string" } - ] + }, + "required" : [ "id", "type" ], + "type" : "object" }, - "JsonApiWorkspaceDataFilterSettingPatch": { - "description": "JSON:API representation of patching workspaceDataFilterSetting entity.", - "properties": { - "attributes": { - "properties": { - "description": { - "maxLength": 10000, - "type": "string" + "JsonApiMetricOut" : { + "description" : "JSON:API representation of metric entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "properties" : { + "format" : { + "description" : "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", + "maxLength" : 2048, + "nullable" : true, + "type" : "string" + }, + "maql" : { + "maxLength" : 10000, + "type" : "string" + }, + "metricType" : { + "description" : "Categorizes metric semantics (e.g., currency).", + "enum" : [ "UNSPECIFIED", "CURRENCY" ], + "type" : "string" + } + }, + "required" : [ "maql" ], + "type" : "object" + }, + "createdAt" : { + "description" : "Time of the entity creation.", + "format" : "date-time", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "isHidden" : { + "type" : "boolean" }, - "filterValues": { - "items": { - "type": "string" + "isHiddenFromKda" : { + "type" : "boolean" + }, + "modifiedAt" : { + "description" : "Time of the last entity modification.", + "format" : "date-time", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" }, - "type": "array" + "type" : "array" }, - "title": { - "maxLength": 255, - "type": "string" + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "type": "object" + "required" : [ "content" ], + "type" : "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "relationships": { - "properties": { - "workspaceDataFilter": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" + }, + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" } }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "workspaceDataFilterSetting" - ], - "example": "workspaceDataFilterSetting", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiWorkspaceDataFilterSettingPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiWorkspaceDataFilterSettingToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingLinkage" - }, - "type": "array" - }, - "JsonApiWorkspaceDataFilterToManyLinkage": { - "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterLinkage" - }, - "type": "array" - }, - "JsonApiWorkspaceDataFilterToOneLinkage": { - "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "nullable": true, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterLinkage" - } - ] - }, - "JsonApiWorkspaceIn": { - "description": "JSON:API representation of workspace entity.", - "properties": { - "attributes": { - "properties": { - "cacheExtraLimit": { - "format": "int64", - "type": "integer" - }, - "dataSource": { - "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", - "properties": { - "id": { - "description": "The ID of the used data source.", - "example": "snowflake.instance.1", - "type": "string" - }, - "schemaPath": { - "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", - "items": { - "description": "The part of the schema path.", - "example": "subPath", - "type": "string" - }, - "type": "array" + "required" : [ "originId", "originType" ], + "type" : "object" + } + }, + "type" : "object" + }, + "relationships" : { + "properties" : { + "attributes" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAttributeToManyLinkage" } }, - "required": [ - "id" - ], - "type": "object" - }, - "description": { - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "earlyAccess": { - "deprecated": true, - "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "earlyAccessValues": { - "description": "The early access feature identifiers. They are used to enable experimental features.", - "items": { - "maxLength": 255, - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "prefix": { - "description": "Custom prefix of entity identifiers in workspace", - "maxLength": 255, - "nullable": true, - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "parent": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + "required" : [ "data" ], + "type" : "object" + }, + "createdBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "workspace" - ], - "example": "workspace", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiWorkspaceInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiWorkspaceLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", - "properties": { - "id": { - "type": "string" - }, - "type": { - "enum": [ - "workspace" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiWorkspaceOut": { - "description": "JSON:API representation of workspace entity.", - "properties": { - "attributes": { - "properties": { - "cacheExtraLimit": { - "format": "int64", - "type": "integer" - }, - "dataSource": { - "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", - "properties": { - "id": { - "description": "The ID of the used data source.", - "example": "snowflake.instance.1", - "type": "string" - }, - "schemaPath": { - "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", - "items": { - "description": "The part of the schema path.", - "example": "subPath", - "type": "string" - }, - "type": "array" + "required" : [ "data" ], + "type" : "object" + }, + "datasets" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDatasetToManyLinkage" } }, - "required": [ - "id" - ], - "type": "object" - }, - "description": { - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "earlyAccess": { - "deprecated": true, - "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "earlyAccessValues": { - "description": "The early access feature identifiers. They are used to enable experimental features.", - "items": { - "maxLength": 255, - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "prefix": { - "description": "Custom prefix of entity identifiers in workspace", - "maxLength": 255, - "nullable": true, - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "config": { - "properties": { - "approximateCountAvailable": { - "default": false, - "description": "is approximate count enabled - based on type of data-source connected to this workspace", - "type": "boolean" - }, - "dataSamplingAvailable": { - "default": false, - "description": "is sampling enabled - based on type of data-source connected to this workspace", - "type": "boolean" - }, - "showAllValuesOnDatesAvailable": { - "default": false, - "description": "is 'show all values' displayed for dates - based on type of data-source connected to this workspace", - "type": "boolean" + "required" : [ "data" ], + "type" : "object" + }, + "facts" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiFactToManyLinkage" } }, - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "dataModel": { - "properties": { - "datasetCount": { - "description": "include the number of dataset of each workspace", - "format": "int32", - "type": "integer" + "labels" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiLabelToManyLinkage" } }, - "required": [ - "datasetCount" - ], - "type": "object" - }, - "hierarchy": { - "properties": { - "childrenCount": { - "description": "include the number of direct children of each workspace", - "format": "int32", - "type": "integer" + "required" : [ "data" ], + "type" : "object" + }, + "metrics" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiMetricToManyLinkage" } }, - "required": [ - "childrenCount" - ], - "type": "object" - }, - "permissions": { - "description": "List of valid permissions for a logged-in user.", - "items": { - "enum": [ - "MANAGE", - "ANALYZE", - "EXPORT", - "EXPORT_TABULAR", - "EXPORT_PDF", - "CREATE_AUTOMATION", - "USE_AI_ASSISTANT", - "CREATE_FILTER_VIEW", - "VIEW" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "parent": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + "required" : [ "data" ], + "type" : "object" + }, + "modifiedBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" } }, - "type": "object" + "type" : "object" }, - "type": { - "description": "Object type", - "enum": [ - "workspace" - ], - "example": "workspace", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "metric" ], + "example" : "metric", + "type" : "string" } }, - "required": [ - "id", - "type" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "JsonApiWorkspaceOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceOut" + "JsonApiMetricOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiMetricOut" }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiMetricOutIncludes" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "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" + } ] }, - "JsonApiWorkspaceOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + "JsonApiMetricOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiMetricOutWithLinks" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiMetricOutIncludes" }, - "type": "array", - "uniqueItems": true + "type" : "array", + "uniqueItems" : true }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "links" : { + "$ref" : "#/components/schemas/ListLinks" }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "type": "object" + "type" : "object" } }, - "required": [ - "data" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "JsonApiWorkspaceOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "JsonApiMetricOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiMetricOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] }, - "JsonApiWorkspacePatch": { - "description": "JSON:API representation of patching workspace entity.", - "properties": { - "attributes": { - "properties": { - "cacheExtraLimit": { - "format": "int64", - "type": "integer" + "JsonApiMetricPatch" : { + "description" : "JSON:API representation of patching metric entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" }, - "dataSource": { - "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", - "properties": { - "id": { - "description": "The ID of the used data source.", - "example": "snowflake.instance.1", - "type": "string" + "content" : { + "properties" : { + "format" : { + "description" : "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", + "maxLength" : 2048, + "nullable" : true, + "type" : "string" }, - "schemaPath": { - "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", - "items": { - "description": "The part of the schema path.", - "example": "subPath", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "description": { - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "earlyAccess": { - "deprecated": true, - "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "earlyAccessValues": { - "description": "The early access feature identifiers. They are used to enable experimental features.", - "items": { - "maxLength": 255, - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "prefix": { - "description": "Custom prefix of entity identifiers in workspace", - "maxLength": 255, - "nullable": true, - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "relationships": { - "properties": { - "parent": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "workspace" - ], - "example": "workspace", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiWorkspacePatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspacePatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiWorkspaceSettingIn": { - "description": "JSON:API representation of workspaceSetting entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_ENDPOINT", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "SORT_CASE_SENSITIVE", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS" - ], - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "workspaceSetting" - ], - "example": "workspaceSetting", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiWorkspaceSettingInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiWorkspaceSettingOut": { - "description": "JSON:API representation of workspaceSetting entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_ENDPOINT", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "SORT_CASE_SENSITIVE", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS" - ], - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "meta": { - "properties": { - "origin": { - "properties": { - "originId": { - "description": "defines id of the workspace where the entity comes from", - "type": "string" + "maql" : { + "maxLength" : 10000, + "type" : "string" }, - "originType": { - "description": "defines type of the origin of the entity", - "enum": [ - "NATIVE", - "PARENT" - ], - "type": "string" + "metricType" : { + "description" : "Categorizes metric semantics (e.g., currency).", + "enum" : [ "UNSPECIFIED", "CURRENCY" ], + "type" : "string" } }, - "required": [ - "originId", - "originType" - ], - "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "workspaceSetting" - ], - "example": "workspaceSetting", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiWorkspaceSettingOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiWorkspaceSettingOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiWorkspaceSettingOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiWorkspaceSettingPatch": { - "description": "JSON:API representation of patching workspaceSetting entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_ENDPOINT", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "SORT_CASE_SENSITIVE", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS" - ], - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "workspaceSetting" - ], - "example": "workspaceSetting", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiWorkspaceSettingPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiWorkspaceSettingPostOptionalId": { - "description": "JSON:API representation of workspaceSetting entity.", - "properties": { - "attributes": { - "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, - "type": { - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_ENDPOINT", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "SORT_CASE_SENSITIVE", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS" - ], - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "workspaceSetting" - ], - "example": "workspaceSetting", - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "JsonApiWorkspaceSettingPostOptionalIdDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalId" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiWorkspaceToOneLinkage": { - "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", - "nullable": true, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceLinkage" - } - ] - }, - "JsonNode": { - "description": "Free-form JSON object", - "example": {}, - "maxLength": 15000, - "nullable": true, - "type": "object" - }, - "LabelIdentifier": { - "description": "A label identifier.", - "properties": { - "id": { - "description": "Label ID.", - "example": "label_id", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "A type of the label.", - "enum": [ - "label" - ], - "example": "label", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "ListLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/ObjectLinks" - }, - { - "properties": { - "next": { - "description": "A string containing the link's URL for the next page of data.", - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - ] - }, - "LocalIdentifier": { - "properties": { - "format": { - "default": "#,##0.00", - "description": "Metric format.", - "example": "#,##0", - "maxLength": 2048, - "nullable": true, - "type": "string" - }, - "localIdentifier": { - "description": "Local identifier of the metric to be compared.", - "example": "m1", - "type": "string" - }, - "title": { - "description": "Metric title.", - "example": "Revenue", - "maxLength": 255, - "nullable": true, - "type": "string" - } - }, - "required": [ - "localIdentifier" - ], - "type": "object" - }, - "LocaleRequest": { - "properties": { - "locale": { - "description": "Requested locale in the form of language tag (see RFC 5646).", - "example": "en-US", - "type": "string" - } - }, - "required": [ - "locale" - ], - "type": "object" - }, - "MeasureDefinition": { - "description": "Abstract metric definition type", - "oneOf": [ - { - "$ref": "#/components/schemas/InlineMeasureDefinition" - }, - { - "$ref": "#/components/schemas/ArithmeticMeasureDefinition" - }, - { - "$ref": "#/components/schemas/SimpleMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopMeasureDefinition" - } - ], - "type": "object" - }, - "MeasureItem": { - "description": "Metric is a quantity that is calculated from the data.", - "properties": { - "definition": { - "$ref": "#/components/schemas/MeasureDefinition" - }, - "localIdentifier": { - "description": "Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.", - "example": "metric_1", - "pattern": "^[.a-zA-Z0-9_-]+$", - "type": "string" - } - }, - "required": [ - "definition", - "localIdentifier" - ], - "type": "object" - }, - "MeasureValueCondition": { - "description": "A condition for filtering by measure value. Can be either a comparison or a range condition.", - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonCondition" - }, - { - "$ref": "#/components/schemas/RangeCondition" - } - ], - "type": "object" - }, - "MeasureValueFilter": { - "description": "Abstract filter definition type filtering by the value of the metric.", - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/RangeMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/CompoundMeasureValueFilter" - } - ], - "type": "object" - }, - "NegativeAttributeFilter": { - "description": "Filter able to limit element values by label and related selected negated elements.", - "properties": { - "negativeAttributeFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" + "required" : [ "maql" ], + "type" : "object" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "isHidden" : { + "type" : "boolean" }, - "label": { - "$ref": "#/components/schemas/AfmIdentifier" + "isHiddenFromKda" : { + "type" : "boolean" }, - "localIdentifier": { - "type": "string" + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" }, - "notIn": { - "$ref": "#/components/schemas/AttributeFilterElements" + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "required": [ - "notIn", - "label" - ], - "type": "object" - } - }, - "required": [ - "negativeAttributeFilter" - ], - "type": "object" - }, - "Note": { - "properties": { - "appliesTo": { - "enum": [ - "SOURCE", - "TARGET" - ], - "type": "string" + "type" : "object" }, - "category": { - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "content": { - "type": "string" - }, - "id": { - "type": "string" - }, - "otherAttributes": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "priority": { - "format": "int32", - "type": "integer" + "type" : { + "description" : "Object type", + "enum" : [ "metric" ], + "example" : "metric", + "type" : "string" } }, - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "Notes": { - "properties": { - "note": { - "items": { - "$ref": "#/components/schemas/Note" - }, - "type": "array" + "JsonApiMetricPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiMetricPatch" } }, - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "NotificationChannelDestination": { - "oneOf": [ - { - "$ref": "#/components/schemas/Webhook" - }, - { - "$ref": "#/components/schemas/Smtp" + "JsonApiMetricPostOptionalId" : { + "description" : "JSON:API representation of metric entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "properties" : { + "format" : { + "description" : "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", + "maxLength" : 2048, + "nullable" : true, + "type" : "string" + }, + "maql" : { + "maxLength" : 10000, + "type" : "string" + }, + "metricType" : { + "description" : "Categorizes metric semantics (e.g., currency).", + "enum" : [ "UNSPECIFIED", "CURRENCY" ], + "type" : "string" + } + }, + "required" : [ "maql" ], + "type" : "object" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "isHidden" : { + "type" : "boolean" + }, + "isHiddenFromKda" : { + "type" : "boolean" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "content" ], + "type" : "object" }, - { - "$ref": "#/components/schemas/DefaultSmtp" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - { - "$ref": "#/components/schemas/InPlatform" - } - ], - "properties": { - "type": { - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "metric" ], + "example" : "metric", + "type" : "string" } }, - "required": [ - "type" - ], - "type": "object" + "required" : [ "attributes", "type" ], + "type" : "object" }, - "ObjectLinks": { - "properties": { - "self": { - "description": "A string containing the link's URL.", - "format": "uri", - "type": "string" + "JsonApiMetricPostOptionalIdDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiMetricPostOptionalId" } }, - "required": [ - "self" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "ObjectLinksContainer": { - "properties": { - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } + "JsonApiMetricToManyLinkage" : { + "description" : "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items" : { + "$ref" : "#/components/schemas/JsonApiMetricLinkage" }, - "type": "object" + "type" : "array" }, - "OrganizationAutomationIdentifier": { - "properties": { - "id": { - "type": "string" - }, - "workspaceId": { - "type": "string" - } - }, - "required": [ - "id", - "workspaceId" - ], - "type": "object" + "JsonApiMetricToOneLinkage" : { + "description" : "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiMetricLinkage" + } ] }, - "OrganizationAutomationManagementBulkRequest": { - "properties": { - "automations": { - "items": { - "$ref": "#/components/schemas/OrganizationAutomationIdentifier" + "JsonApiNotificationChannelIdentifierOut" : { + "description" : "JSON:API representation of notificationChannelIdentifier entity.", + "properties" : { + "attributes" : { + "properties" : { + "allowedRecipients" : { + "description" : "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", + "enum" : [ "CREATOR", "INTERNAL", "EXTERNAL" ], + "type" : "string" + }, + "description" : { + "maxLength" : 10000, + "nullable" : true, + "type" : "string" + }, + "destinationType" : { + "enum" : [ "WEBHOOK", "SMTP", "DEFAULT_SMTP", "IN_PLATFORM" ], + "type" : "string" + }, + "name" : { + "maxLength" : 255, + "nullable" : true, + "type" : "string" + } }, - "type": "array" - } + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "notificationChannelIdentifier" ], + "example" : "notificationChannelIdentifier", + "type" : "string" + } }, - "required": [ - "automations" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "OrganizationPermissionAssignment": { - "description": "Organization permission assignments", - "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" - }, - "permissions": { - "items": { - "enum": [ - "MANAGE", - "SELF_CREATE_TOKEN" - ], - "type": "string" + "JsonApiNotificationChannelIdentifierOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelIdentifierOut" + }, + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiNotificationChannelIdentifierOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelIdentifierOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } + }, + "type" : "object" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiNotificationChannelIdentifierOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiNotificationChannelIdentifierOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiNotificationChannelIn" : { + "description" : "JSON:API representation of notificationChannel entity.", + "properties" : { + "attributes" : { + "properties" : { + "allowedRecipients" : { + "description" : "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", + "enum" : [ "CREATOR", "INTERNAL", "EXTERNAL" ], + "type" : "string" + }, + "customDashboardUrl" : { + "description" : "Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are:\n{workspaceId}\n{dashboardId}\n{automationId}\n{asOfDate}\n", + "maxLength" : 255, + "type" : "string" + }, + "dashboardLinkVisibility" : { + "description" : "Dashboard link visibility in notifications.\nHIDDEN - the link will not be included\nINTERNAL_ONLY - only internal users will see the link\nALL - all users will see the link\n", + "enum" : [ "HIDDEN", "INTERNAL_ONLY", "ALL" ], + "type" : "string" + }, + "description" : { + "maxLength" : 10000, + "nullable" : true, + "type" : "string" + }, + "destination" : { + "description" : "The destination where the notifications are to be sent.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultSmtp" + }, { + "$ref" : "#/components/schemas/InPlatform" + }, { + "$ref" : "#/components/schemas/Smtp" + }, { + "$ref" : "#/components/schemas/Webhook" + } ] + }, + "inPlatformNotification" : { + "description" : "In-platform notifications configuration. No effect if the destination type is IN_PLATFORM.\nDISABLED - in-platform notifications are not sent\nENABLED - in-platform notifications are sent in addition to the regular notifications\n", + "enum" : [ "DISABLED", "ENABLED" ], + "type" : "string" + }, + "name" : { + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "notificationSource" : { + "description" : "Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are:\n{{workspaceId}}\n{{workspaceName}}\n{{workspaceDescription}}\n{{dashboardId}}\n{{dashboardName}}\n{{dashboardDescription}}\n", + "maxLength" : 10000, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "notificationChannel" ], + "example" : "notificationChannel", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiNotificationChannelInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiNotificationChannelLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "notificationChannel" ], + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiNotificationChannelOut" : { + "description" : "JSON:API representation of notificationChannel entity.", + "properties" : { + "attributes" : { + "properties" : { + "allowedRecipients" : { + "description" : "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", + "enum" : [ "CREATOR", "INTERNAL", "EXTERNAL" ], + "type" : "string" + }, + "customDashboardUrl" : { + "description" : "Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are:\n{workspaceId}\n{dashboardId}\n{automationId}\n{asOfDate}\n", + "maxLength" : 255, + "type" : "string" + }, + "dashboardLinkVisibility" : { + "description" : "Dashboard link visibility in notifications.\nHIDDEN - the link will not be included\nINTERNAL_ONLY - only internal users will see the link\nALL - all users will see the link\n", + "enum" : [ "HIDDEN", "INTERNAL_ONLY", "ALL" ], + "type" : "string" + }, + "description" : { + "maxLength" : 10000, + "nullable" : true, + "type" : "string" + }, + "destination" : { + "description" : "The destination where the notifications are to be sent.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultSmtp" + }, { + "$ref" : "#/components/schemas/InPlatform" + }, { + "$ref" : "#/components/schemas/Smtp" + }, { + "$ref" : "#/components/schemas/Webhook" + } ] + }, + "destinationType" : { + "enum" : [ "WEBHOOK", "SMTP", "DEFAULT_SMTP", "IN_PLATFORM" ], + "nullable" : true, + "type" : "string" + }, + "inPlatformNotification" : { + "description" : "In-platform notifications configuration. No effect if the destination type is IN_PLATFORM.\nDISABLED - in-platform notifications are not sent\nENABLED - in-platform notifications are sent in addition to the regular notifications\n", + "enum" : [ "DISABLED", "ENABLED" ], + "type" : "string" + }, + "name" : { + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "notificationSource" : { + "description" : "Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are:\n{{workspaceId}}\n{{workspaceName}}\n{{workspaceDescription}}\n{{dashboardId}}\n{{dashboardName}}\n{{dashboardDescription}}\n", + "maxLength" : 10000, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "notificationChannel" ], + "example" : "notificationChannel", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiNotificationChannelOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelOut" + }, + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiNotificationChannelOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } + }, + "type" : "object" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiNotificationChannelOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiNotificationChannelOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiNotificationChannelPatch" : { + "description" : "JSON:API representation of patching notificationChannel entity.", + "properties" : { + "attributes" : { + "properties" : { + "allowedRecipients" : { + "description" : "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", + "enum" : [ "CREATOR", "INTERNAL", "EXTERNAL" ], + "type" : "string" + }, + "customDashboardUrl" : { + "description" : "Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are:\n{workspaceId}\n{dashboardId}\n{automationId}\n{asOfDate}\n", + "maxLength" : 255, + "type" : "string" + }, + "dashboardLinkVisibility" : { + "description" : "Dashboard link visibility in notifications.\nHIDDEN - the link will not be included\nINTERNAL_ONLY - only internal users will see the link\nALL - all users will see the link\n", + "enum" : [ "HIDDEN", "INTERNAL_ONLY", "ALL" ], + "type" : "string" + }, + "description" : { + "maxLength" : 10000, + "nullable" : true, + "type" : "string" + }, + "destination" : { + "description" : "The destination where the notifications are to be sent.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultSmtp" + }, { + "$ref" : "#/components/schemas/InPlatform" + }, { + "$ref" : "#/components/schemas/Smtp" + }, { + "$ref" : "#/components/schemas/Webhook" + } ] + }, + "inPlatformNotification" : { + "description" : "In-platform notifications configuration. No effect if the destination type is IN_PLATFORM.\nDISABLED - in-platform notifications are not sent\nENABLED - in-platform notifications are sent in addition to the regular notifications\n", + "enum" : [ "DISABLED", "ENABLED" ], + "type" : "string" + }, + "name" : { + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "notificationSource" : { + "description" : "Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are:\n{{workspaceId}}\n{{workspaceName}}\n{{workspaceDescription}}\n{{dashboardId}}\n{{dashboardName}}\n{{dashboardDescription}}\n", + "maxLength" : 10000, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "notificationChannel" ], + "example" : "notificationChannel", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiNotificationChannelPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelPatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiNotificationChannelPostOptionalId" : { + "description" : "JSON:API representation of notificationChannel entity.", + "properties" : { + "attributes" : { + "properties" : { + "allowedRecipients" : { + "description" : "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", + "enum" : [ "CREATOR", "INTERNAL", "EXTERNAL" ], + "type" : "string" + }, + "customDashboardUrl" : { + "description" : "Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are:\n{workspaceId}\n{dashboardId}\n{automationId}\n{asOfDate}\n", + "maxLength" : 255, + "type" : "string" + }, + "dashboardLinkVisibility" : { + "description" : "Dashboard link visibility in notifications.\nHIDDEN - the link will not be included\nINTERNAL_ONLY - only internal users will see the link\nALL - all users will see the link\n", + "enum" : [ "HIDDEN", "INTERNAL_ONLY", "ALL" ], + "type" : "string" + }, + "description" : { + "maxLength" : 10000, + "nullable" : true, + "type" : "string" + }, + "destination" : { + "description" : "The destination where the notifications are to be sent.", + "oneOf" : [ { + "$ref" : "#/components/schemas/DefaultSmtp" + }, { + "$ref" : "#/components/schemas/InPlatform" + }, { + "$ref" : "#/components/schemas/Smtp" + }, { + "$ref" : "#/components/schemas/Webhook" + } ] + }, + "inPlatformNotification" : { + "description" : "In-platform notifications configuration. No effect if the destination type is IN_PLATFORM.\nDISABLED - in-platform notifications are not sent\nENABLED - in-platform notifications are sent in addition to the regular notifications\n", + "enum" : [ "DISABLED", "ENABLED" ], + "type" : "string" + }, + "name" : { + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "notificationSource" : { + "description" : "Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are:\n{{workspaceId}}\n{{workspaceName}}\n{{workspaceDescription}}\n{{dashboardId}}\n{{dashboardName}}\n{{dashboardDescription}}\n", + "maxLength" : 10000, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "notificationChannel" ], + "example" : "notificationChannel", + "type" : "string" + } + }, + "required" : [ "type" ], + "type" : "object" + }, + "JsonApiNotificationChannelPostOptionalIdDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelPostOptionalId" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiNotificationChannelToOneLinkage" : { + "description" : "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiNotificationChannelLinkage" + } ] + }, + "JsonApiOrganizationIn" : { + "description" : "JSON:API representation of organization entity.", + "properties" : { + "attributes" : { + "properties" : { + "allowedOrigins" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "earlyAccess" : { + "deprecated" : true, + "description" : "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "earlyAccessValues" : { + "description" : "The early access feature identifiers. They are used to enable experimental features.", + "items" : { + "maxLength" : 255, + "type" : "string" + }, + "nullable" : true, + "type" : "array" + }, + "hostname" : { + "maxLength" : 255, + "type" : "string" + }, + "name" : { + "maxLength" : 255, + "nullable" : true, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "identityProvider" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } }, - "type": "array" + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "organization" ], + "example" : "organization", + "type" : "string" } }, - "required": [ - "assigneeIdentifier", - "permissions" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "Over": { - "properties": { - "attributes": { - "items": { - "$ref": "#/components/schemas/IdentifierRef" - }, - "type": "array" + "JsonApiOrganizationInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiOrganizationIn" } }, - "required": [ - "attributes" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "PageMetadata": { - "properties": { - "number": { - "description": "The number of the current page", - "format": "int32", - "type": "integer" - }, - "size": { - "description": "The size of the current page", - "format": "int32", - "type": "integer" - }, - "totalElements": { - "description": "The total number of elements", - "format": "int32", - "type": "integer" - }, - "totalPages": { - "description": "The total number of pages", - "format": "int32", - "type": "integer" + "JsonApiOrganizationOut" : { + "description" : "JSON:API representation of organization entity.", + "properties" : { + "attributes" : { + "properties" : { + "allowedOrigins" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "cacheSettings" : { + "properties" : { + "cacheStrategy" : { + "enum" : [ "DURABLE", "EPHEMERAL" ], + "maxLength" : 255, + "type" : "string" + }, + "extraCacheBudget" : { + "format" : "int64", + "type" : "integer" + } + }, + "type" : "object" + }, + "dataCenter" : { + "description" : "Current deployment region. Should be used for issue investigation only.", + "nullable" : true, + "type" : "string" + }, + "earlyAccess" : { + "deprecated" : true, + "description" : "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "earlyAccessValues" : { + "description" : "The early access feature identifiers. They are used to enable experimental features.", + "items" : { + "maxLength" : 255, + "type" : "string" + }, + "nullable" : true, + "type" : "array" + }, + "hostname" : { + "maxLength" : 255, + "type" : "string" + }, + "name" : { + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "region" : { + "description" : "Current deployment cluster name. Should be used for issue investigation only.", + "nullable" : true, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "meta" : { + "properties" : { + "permissions" : { + "description" : "List of valid permissions for a logged-in user.", + "items" : { + "enum" : [ "MANAGE", "SELF_CREATE_TOKEN" ], + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "relationships" : { + "properties" : { + "bootstrapUser" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "bootstrapUserGroup" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserGroupToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "identityProvider" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "organization" ], + "example" : "organization", + "type" : "string" } }, - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "Parameter": { - "properties": { - "name": { - "type": "string" + "JsonApiOrganizationOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiOrganizationOut" + }, + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiOrganizationOutIncludes" + }, + "type" : "array", + "uniqueItems" : true }, - "value": { - "type": "string" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "required": [ - "name", - "value" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "PdfTableStyle": { - "deprecated": true, - "description": "Custom CSS styles for the table. (PDF, HTML)", - "example": [ - { - "properties": [ - { - "key": "font-size", - "value": "30px" - } - ], - "selector": "th" - } - ], - "properties": { - "properties": { - "description": "List of CSS properties.", - "items": { - "$ref": "#/components/schemas/PdfTableStyleProperty" - }, - "type": "array" + "JsonApiOrganizationOutIncludes" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiUserOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiIdentityProviderOutWithLinks" + } ] + }, + "JsonApiOrganizationPatch" : { + "description" : "JSON:API representation of patching organization entity.", + "properties" : { + "attributes" : { + "properties" : { + "allowedOrigins" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "earlyAccess" : { + "deprecated" : true, + "description" : "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "earlyAccessValues" : { + "description" : "The early access feature identifiers. They are used to enable experimental features.", + "items" : { + "maxLength" : 255, + "type" : "string" + }, + "nullable" : true, + "type" : "array" + }, + "hostname" : { + "maxLength" : 255, + "type" : "string" + }, + "name" : { + "maxLength" : 255, + "nullable" : true, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "identityProvider" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" }, - "selector": { - "description": "CSS selector where to apply given properties.", - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "organization" ], + "example" : "organization", + "type" : "string" } }, - "required": [ - "selector" - ], - "type": "object" + "required" : [ "id", "type" ], + "type" : "object" }, - "PdfTableStyleProperty": { - "description": "CSS property.", - "properties": { - "key": { - "description": "CSS property key.", - "type": "string" - }, - "value": { - "description": "CSS property value.", - "type": "string" + "JsonApiOrganizationPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiOrganizationPatch" } }, - "required": [ - "key", - "value" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "PdmLdmRequest": { - "description": "PDM additions wrapper.", - "properties": { - "sqls": { - "description": "List of SQL datasets.", - "items": { - "$ref": "#/components/schemas/PdmSql" + "JsonApiOrganizationSettingIn" : { + "description" : "JSON:API representation of organizationSetting entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { }, + "type" : "object" + }, + "type" : { + "enum" : [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS" ], + "type" : "string" + } }, - "type": "array" + "type" : "object" }, - "tableOverrides": { - "description": "(BETA) List of table overrides.", - "items": { - "$ref": "#/components/schemas/TableOverride" - }, - "type": "array" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "tables": { - "description": "List of physical database tables.", - "items": { - "$ref": "#/components/schemas/DeclarativeTable" - }, - "type": "array" + "type" : { + "description" : "Object type", + "enum" : [ "organizationSetting" ], + "example" : "organizationSetting", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiOrganizationSettingInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingIn" } }, - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "PdmSql": { - "description": "SQL dataset definition.", - "properties": { - "columns": { - "description": "Columns defining SQL dataset.", - "items": { - "$ref": "#/components/schemas/SqlColumn" + "JsonApiOrganizationSettingOut" : { + "description" : "JSON:API representation of organizationSetting entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { }, + "type" : "object" + }, + "type" : { + "enum" : [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS" ], + "type" : "string" + } }, - "type": "array" + "type" : "object" }, - "statement": { - "description": "SQL statement.", - "example": "select * from abc", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "title": { - "description": "SQL dataset title.", - "example": "My special dataset", - "type": "string" - } - }, - "required": [ - "statement", - "title" - ], - "type": "object" - }, - "PermissionsAssignment": { - "properties": { - "assignees": { - "items": { - "$ref": "#/components/schemas/AssigneeIdentifier" - }, - "type": "array" + "type" : { + "description" : "Object type", + "enum" : [ "organizationSetting" ], + "example" : "organizationSetting", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiOrganizationSettingOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingOut" }, - "dataSources": { - "items": { - "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiOrganizationSettingOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingOutWithLinks" }, - "type": "array" + "type" : "array", + "uniqueItems" : true }, - "workspaces": { - "items": { - "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } }, - "type": "array" + "type" : "object" } }, - "required": [ - "assignees" - ], - "type": "object" - }, - "PermissionsForAssignee": { - "allOf": [ - { - "$ref": "#/components/schemas/DashboardPermissionsAssignment" - }, - { - "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" - } - }, - "type": "object" - } - ], - "description": "Desired levels of permissions for an assignee identified by an identifier.", - "required": [ - "assigneeIdentifier", - "permissions" - ], - "type": "object" - }, - "PermissionsForAssigneeRule": { - "allOf": [ - { - "$ref": "#/components/schemas/DashboardPermissionsAssignment" + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiOrganizationSettingOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiOrganizationSettingPatch" : { + "description" : "JSON:API representation of patching organizationSetting entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { }, + "type" : "object" + }, + "type" : { + "enum" : [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS" ], + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - { - "properties": { - "assigneeRule": { - "$ref": "#/components/schemas/AssigneeRule" - } - }, - "type": "object" + "type" : { + "description" : "Object type", + "enum" : [ "organizationSetting" ], + "example" : "organizationSetting", + "type" : "string" } - ], - "description": "Desired levels of permissions for a collection of assignees identified by a rule.", - "required": [ - "assigneeRule", - "permissions" - ], - "type": "object" + }, + "required" : [ "id", "type" ], + "type" : "object" }, - "PlatformUsage": { - "properties": { - "count": { - "format": "int32", - "type": "integer" - }, - "name": { - "enum": [ - "UserCount", - "WorkspaceCount" - ], - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "PlatformUsageRequest": { - "properties": { - "usageItemNames": { - "items": { - "enum": [ - "UserCount", - "WorkspaceCount" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "usageItemNames" - ], - "type": "object" - }, - "PopDataset": { - "description": "Combination of the date data set to use and how many periods ago to calculate the previous period for.", - "properties": { - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" - }, - "periodsAgo": { - "description": "Number of periods ago to calculate the previous period for.", - "example": 1, - "format": "int32", - "type": "integer" - } - }, - "required": [ - "dataset", - "periodsAgo" - ], - "type": "object" - }, - "PopDatasetMeasureDefinition": { - "description": "Previous period type of metric.", - "properties": { - "previousPeriodMeasure": { - "properties": { - "dateDatasets": { - "description": "Specification of which date data sets to use for determining the period to calculate the previous period for.", - "items": { - "$ref": "#/components/schemas/PopDataset" - }, - "type": "array" - }, - "measureIdentifier": { - "$ref": "#/components/schemas/AfmLocalIdentifier" - } - }, - "required": [ - "dateDatasets", - "measureIdentifier" - ], - "type": "object" - } - }, - "required": [ - "previousPeriodMeasure" - ], - "type": "object" - }, - "PopDate": { - "description": "Combination of the date attribute to use and how many periods ago to calculate the PoP for.", - "properties": { - "attribute": { - "$ref": "#/components/schemas/AfmObjectIdentifierAttribute" - }, - "periodsAgo": { - "description": "Number of periods ago to calculate the previous period for.", - "example": 1, - "format": "int32", - "type": "integer" - } - }, - "required": [ - "attribute", - "periodsAgo" - ], - "type": "object" - }, - "PopDateMeasureDefinition": { - "description": "Period over period type of metric.", - "properties": { - "overPeriodMeasure": { - "properties": { - "dateAttributes": { - "description": "Attributes to use for determining the period to calculate the PoP for.", - "items": { - "$ref": "#/components/schemas/PopDate" - }, - "type": "array" - }, - "measureIdentifier": { - "$ref": "#/components/schemas/AfmLocalIdentifier" - } - }, - "required": [ - "dateAttributes", - "measureIdentifier" - ], - "type": "object" - } - }, - "required": [ - "overPeriodMeasure" - ], - "type": "object" - }, - "PopMeasureDefinition": { - "oneOf": [ - { - "$ref": "#/components/schemas/PopDatasetMeasureDefinition" - }, - { - "$ref": "#/components/schemas/PopDateMeasureDefinition" - } - ], - "type": "object" - }, - "PositiveAttributeFilter": { - "description": "Filter able to limit element values by label and related selected elements.", - "properties": { - "positiveAttributeFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "in": { - "$ref": "#/components/schemas/AttributeFilterElements" - }, - "label": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "localIdentifier": { - "type": "string" - } - }, - "required": [ - "in", - "label" - ], - "type": "object" - } - }, - "required": [ - "positiveAttributeFilter" - ], - "type": "object" - }, - "Range": { - "properties": { - "from": { - "$ref": "#/components/schemas/Value" - }, - "measure": { - "$ref": "#/components/schemas/LocalIdentifier" - }, - "operator": { - "enum": [ - "BETWEEN", - "NOT_BETWEEN" - ], - "type": "string" - }, - "to": { - "$ref": "#/components/schemas/Value" - } - }, - "required": [ - "from", - "measure", - "operator", - "to" - ], - "type": "object" - }, - "RangeCondition": { - "description": "Condition that checks if the metric value is within a given range.", - "properties": { - "range": { - "properties": { - "from": { - "example": 100, - "type": "number" - }, - "operator": { - "enum": [ - "BETWEEN", - "NOT_BETWEEN" - ], - "example": "BETWEEN", - "type": "string" - }, - "to": { - "example": 999, - "type": "number" - } - }, - "required": [ - "from", - "operator", - "to" - ], - "type": "object" - } - }, - "required": [ - "range" - ], - "type": "object" - }, - "RangeMeasureValueFilter": { - "description": "Filter the result by comparing specified metric to given range of values.", - "properties": { - "rangeMeasureValueFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "type": "array" - }, - "from": { - "example": 100, - "type": "number" - }, - "localIdentifier": { - "type": "string" - }, - "measure": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "operator": { - "enum": [ - "BETWEEN", - "NOT_BETWEEN" - ], - "example": "BETWEEN", - "type": "string" - }, - "to": { - "example": 999, - "type": "number" - }, - "treatNullValuesAs": { - "description": "A value that will be substituted for null values in the metric for the comparisons.", - "example": 0, - "type": "number" - } - }, - "required": [ - "from", - "operator", - "to", - "measure" - ], - "type": "object" - } - }, - "required": [ - "rangeMeasureValueFilter" - ], - "type": "object" - }, - "RangeWrapper": { - "properties": { - "range": { - "$ref": "#/components/schemas/Range" - } - }, - "required": [ - "range" - ], - "type": "object" - }, - "RankingFilter": { - "description": "Filter the result on top/bottom N values according to given metric(s).", - "properties": { - "rankingFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "type": "array" - }, - "localIdentifier": { - "type": "string" - }, - "measures": { - "description": "References to the metrics to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "type": "array" - }, - "operator": { - "description": "The type of ranking to use, TOP or BOTTOM.", - "enum": [ - "TOP", - "BOTTOM" - ], - "type": "string" - }, - "value": { - "description": "Number of top/bottom values to filter.", - "example": 5, - "format": "int32", - "type": "integer" - } - }, - "required": [ - "measures", - "operator", - "value" - ], - "type": "object" - } - }, - "required": [ - "rankingFilter" - ], - "type": "object" - }, - "RawCustomLabel": { - "description": "Custom label object override.", - "properties": { - "title": { - "description": "Override value.", - "type": "string" - } - }, - "required": [ - "title" - ], - "type": "object" - }, - "RawCustomMetric": { - "description": "Custom metric object override.", - "properties": { - "title": { - "description": "Metric title override.", - "type": "string" - } - }, - "required": [ - "title" - ], - "type": "object" - }, - "RawCustomOverride": { - "description": "Custom cell value overrides (IDs will be replaced with specified values).", - "properties": { - "labels": { - "additionalProperties": { - "$ref": "#/components/schemas/RawCustomLabel" - }, - "description": "Map of CustomLabels with keys used as placeholders in export result.", - "type": "object" - }, - "metrics": { - "additionalProperties": { - "$ref": "#/components/schemas/RawCustomMetric" - }, - "description": "Map of CustomMetrics with keys used as placeholders in export result.", - "type": "object" - } - }, - "type": "object" - }, - "RawExportAutomationRequest": { - "description": "Export request object describing the export properties and overrides for raw exports.", - "properties": { - "customOverride": { - "$ref": "#/components/schemas/RawCustomOverride" - }, - "delimiter": { - "description": "Set column delimiter. (CSV)", - "maxLength": 1, - "minLength": 1, - "pattern": "^[^\\r\\n\"]$", - "type": "string" - }, - "execution": { - "$ref": "#/components/schemas/AFM" - }, - "executionSettings": { - "$ref": "#/components/schemas/ExecutionSettings" - }, - "fileName": { - "description": "Filename of downloaded file without extension.", - "example": "result", - "type": "string" - }, - "format": { - "description": "Requested resulting file type.", - "enum": [ - "ARROW_FILE", - "ARROW_STREAM", - "CSV" - ], - "example": "CSV", - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/JsonNode" - } - }, - "required": [ - "execution", - "fileName", - "format" - ], - "type": "object" - }, - "ReferenceIdentifier": { - "description": "A reference identifier.", - "properties": { - "id": { - "description": "Reference ID.", - "example": "customers", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "A type of the reference.", - "enum": [ - "dataset" - ], - "example": "DATASET", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "ReferenceSourceColumn": { - "properties": { - "column": { - "type": "string" - }, - "dataType": { - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "type": "string" - }, - "isNullable": { - "type": "boolean" - }, - "nullValue": { - "type": "string" - }, - "target": { - "$ref": "#/components/schemas/DatasetGrain" - } - }, - "required": [ - "column", - "target" - ], - "type": "object" - }, - "Relative": { - "properties": { - "measure": { - "$ref": "#/components/schemas/ArithmeticMeasure" - }, - "operator": { - "description": "Relative condition operator.\nINCREASES_BY - the metric increases by the specified value.\nDECREASES_BY - the metric decreases by the specified value.\nCHANGES_BY - the metric increases or decreases by the specified value.\n", - "enum": [ - "INCREASES_BY", - "DECREASES_BY", - "CHANGES_BY" - ], - "type": "string" - }, - "threshold": { - "$ref": "#/components/schemas/Value" - } - }, - "required": [ - "measure", - "operator", - "threshold" - ], - "type": "object" - }, - "RelativeBoundedDateFilter": { - "properties": { - "from": { - "format": "int32", - "type": "integer" - }, - "granularity": { - "enum": [ - "ALL_TIME_GRANULARITY", - "GDC.time.year", - "GDC.time.week_us", - "GDC.time.week_in_year", - "GDC.time.week_in_quarter", - "GDC.time.week", - "GDC.time.euweek_in_year", - "GDC.time.euweek_in_quarter", - "GDC.time.quarter", - "GDC.time.quarter_in_year", - "GDC.time.month", - "GDC.time.month_in_quarter", - "GDC.time.month_in_year", - "GDC.time.day_in_year", - "GDC.time.day_in_quarter", - "GDC.time.day_in_month", - "GDC.time.day_in_week", - "GDC.time.day_in_euweek", - "GDC.time.date", - "GDC.time.hour", - "GDC.time.hour_in_day", - "GDC.time.minute", - "GDC.time.minute_in_hour", - "GDC.time.fiscal_month", - "GDC.time.fiscal_quarter", - "GDC.time.fiscal_year" - ], - "type": "string" - }, - "to": { - "format": "int32", - "type": "integer" - } - }, - "required": [ - "granularity" - ], - "type": "object" - }, - "RelativeDateFilter": { - "description": "A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both.", - "properties": { - "relativeDateFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "boundedFilter": { - "$ref": "#/components/schemas/BoundedFilter" - }, - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" - }, - "from": { - "description": "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago').", - "example": -6, - "format": "int32", - "type": "integer" - }, - "granularity": { - "description": "Date granularity specifying particular date attribute in given dimension.", - "enum": [ - "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "QUARTER", - "YEAR", - "MINUTE_OF_HOUR", - "HOUR_OF_DAY", - "DAY_OF_WEEK", - "DAY_OF_MONTH", - "DAY_OF_QUARTER", - "DAY_OF_YEAR", - "WEEK_OF_YEAR", - "MONTH_OF_YEAR", - "QUARTER_OF_YEAR", - "FISCAL_MONTH", - "FISCAL_QUARTER", - "FISCAL_YEAR" - ], - "example": "DAY", - "type": "string" - }, - "includeEmptyValues": { - "description": "If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).", - "type": "boolean" - }, - "localIdentifier": { - "type": "string" - }, - "to": { - "description": "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...).", - "example": 0, - "format": "int32", - "type": "integer" - } - }, - "required": [ - "from", - "granularity", - "to", - "dataset" - ], - "type": "object" - } - }, - "required": [ - "relativeDateFilter" - ], - "type": "object" - }, - "RelativeWrapper": { - "properties": { - "relative": { - "$ref": "#/components/schemas/Relative" - } - }, - "required": [ - "relative" - ], - "type": "object" - }, - "ResolveSettingsRequest": { - "description": "A request containing setting IDs to resolve.", - "properties": { - "settings": { - "description": "An array of setting IDs to resolve.", - "example": [ - "timezone" - ], - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "settings" - ], - "type": "object" - }, - "ResolvedSetting": { - "description": "Setting and its value.", - "properties": { - "content": { - "$ref": "#/components/schemas/JsonNode" - }, - "id": { - "deprecated": true, - "description": "Setting ID. Formerly used to identify a type of a particular setting, going to be removed in a favor of setting's type.", - "type": "string" - }, - "type": { - "description": "Type of the setting.", - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "ACTIVE_LLM_ENDPOINT", - "ACTIVE_CALENDARS", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "AG_GRID_TOKEN", - "WEEK_START", - "FISCAL_YEAR", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED", - "OPENAI_CONFIG", - "ENABLE_FILE_ANALYTICS", - "ALERT", - "SEPARATORS", - "DATE_FILTER_CONFIG", - "JIT_PROVISIONING", - "JWT_JIT_PROVISIONING", - "DASHBOARD_FILTERS_APPLY_MODE", - "ENABLE_SLIDES_EXPORT", - "ENABLE_SNAPSHOT_EXPORT", - "AI_RATE_LIMIT", - "ATTACHMENT_SIZE_LIMIT", - "ATTACHMENT_LINK_TTL", - "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", - "ENABLE_DRILL_TO_URL_BY_DEFAULT", - "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", - "ENABLE_AUTOMATION_EVALUATION_MODE", - "ENABLE_ACCESSIBILITY_MODE", - "REGISTERED_PLUGGABLE_APPLICATIONS", - "DATA_LOCALE", - "LDM_DEFAULT_LOCALE", - "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", - "MAX_ZOOM_LEVEL", - "SORT_CASE_SENSITIVE", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS" - ], - "example": "TIMEZONE", - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "RsaSpecification": { - "properties": { - "alg": { - "enum": [ - "RS256", - "RS384", - "RS512" - ], - "type": "string" - }, - "e": { - "type": "string" - }, - "kid": { - "type": "string" - }, - "kty": { - "enum": [ - "RSA" - ], - "type": "string" - }, - "n": { - "type": "string" - }, - "use": { - "enum": [ - "sig" - ], - "type": "string" - }, - "x5c": { - "items": { - "type": "string" - }, - "type": "array" - }, - "x5t": { - "type": "string" - } - }, - "required": [ - "alg", - "e", - "kid", - "kty", - "n", - "use" - ], - "type": "object" - }, - "RulePermission": { - "description": "List of rules", - "properties": { - "permissions": { - "description": "Permissions granted by the rule", - "items": { - "$ref": "#/components/schemas/GrantedPermission" - }, - "type": "array" - }, - "type": { - "description": "Type of the rule", - "example": "allWorkspaceUsers", - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "RunningSection": { - "description": "Footer section of the slide", - "nullable": true, - "properties": { - "left": { - "description": "Either {{logo}} variable or custom text with combination of other variables.", - "nullable": true, - "type": "string" - }, - "right": { - "description": "Either {{logo}} variable or custom text with combination of other variables.", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "SectionSlideTemplate": { - "description": "Settings for section slide.", - "nullable": true, - "properties": { - "backgroundImage": { - "default": true, - "description": "Show background image on the slide.", - "type": "boolean" - }, - "footer": { - "$ref": "#/components/schemas/RunningSection" - }, - "header": { - "$ref": "#/components/schemas/RunningSection" - } - }, - "type": "object" - }, - "Settings": { - "description": "Additional settings.", - "properties": { - "delimiter": { - "description": "Set column delimiter. (CSV)", - "maxLength": 1, - "minLength": 1, - "pattern": "^[^\\r\\n\"]$", - "type": "string" - }, - "exportInfo": { - "default": false, - "description": "If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF)", - "example": true, - "type": "boolean" - }, - "mergeHeaders": { - "description": "Merge equal headers in neighbouring cells. (XLSX)", - "example": true, - "type": "boolean" - }, - "pageOrientation": { - "default": "PORTRAIT", - "description": "Set page orientation. (PDF)", - "enum": [ - "PORTRAIT", - "LANDSCAPE" - ], - "type": "string" - }, - "pageSize": { - "default": "A4", - "description": "Set page size. (PDF)", - "enum": [ - "A3", - "A4", - "LETTER" - ], - "type": "string" - }, - "pdfPageSize": { - "deprecated": true, - "description": "Page size and orientation. (PDF)", - "example": "a4 landscape", - "type": "string" - }, - "pdfTableStyle": { - "deprecated": true, - "description": "Custom CSS styles for the table. (PDF, HTML)", - "example": [ - { - "properties": [ - { - "key": "font-size", - "value": "30px" - } - ], - "selector": "th" - } - ], - "items": { - "$ref": "#/components/schemas/PdfTableStyle" - }, - "type": "array" - }, - "pdfTopLeftContent": { - "deprecated": true, - "description": "Top left header content. (PDF)", - "example": "Good", - "type": "string" - }, - "pdfTopRightContent": { - "deprecated": true, - "description": "Top right header content. (PDF)", - "example": "Morning", - "type": "string" - }, - "showFilters": { - "deprecated": true, - "description": "Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)", - "example": false, - "type": "boolean" - } - }, - "type": "object" - }, - "SimpleMeasureDefinition": { - "description": "Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.", - "properties": { - "measure": { - "properties": { - "aggregation": { - "description": "Definition of aggregation type of the metric.", - "enum": [ - "SUM", - "COUNT", - "AVG", - "MIN", - "MAX", - "MEDIAN", - "RUNSUM", - "APPROXIMATE_COUNT" - ], - "example": "SUM", - "type": "string" - }, - "computeRatio": { - "default": false, - "description": "If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).", - "example": true, - "type": "boolean" - }, - "filters": { - "description": "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.", - "items": { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" - }, - "type": "array" - }, - "item": { - "$ref": "#/components/schemas/AfmObjectIdentifierCore" - } - }, - "required": [ - "item" - ], - "type": "object" - } - }, - "required": [ - "measure" - ], - "type": "object" - }, - "Skeleton": { - "properties": { - "content": { - "items": { - "type": "object" - }, - "type": "array" - }, - "href": { - "type": "string" - } - }, - "type": "object" - }, - "SlidesExportRequest": { - "description": "Export request object describing the export properties and metadata for slides exports.", - "properties": { - "dashboardId": { - "description": "Dashboard identifier", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - "type": "string" - }, - "fileName": { - "description": "File name to be used for retrieving the pdf document.", - "example": "filename", - "type": "string" - }, - "format": { - "description": "Requested resulting file type.", - "enum": [ - "PDF", - "PPTX" - ], - "example": "PDF", - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/JsonNode" - }, - "templateId": { - "description": "Export template identifier.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "visualizationIds": { - "description": "List of visualization ids to be exported. Note that only one visualization is currently supported.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true - }, - "widgetIds": { - "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "fileName", - "format" - ], - "type": "object" - }, - "Smtp": { - "allOf": [ - { - "properties": { - "fromEmail": { - "default": "no-reply@gooddata.com", - "description": "E-mail address to send notifications from.", - "format": "email", - "type": "string" - }, - "fromEmailName": { - "default": "GoodData", - "description": "An optional e-mail name to send notifications from.", - "type": "string" - }, - "host": { - "description": "The SMTP server address.", - "type": "string" - }, - "password": { - "description": "The SMTP server password.", - "type": "string", - "writeOnly": true - }, - "port": { - "description": "The SMTP server port.", - "enum": [ - 25, - 465, - 587, - 2525 - ], - "format": "int32", - "type": "integer" - }, - "type": { - "description": "The destination type.", - "enum": [ - "SMTP" - ], - "type": "string" - }, - "username": { - "description": "The SMTP server username.", - "type": "string" - } - }, - "type": "object" - } - ], - "description": "Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update", - "required": [ - "type" - ], - "type": "object" - }, - "SqlColumn": { - "description": "Columns defining SQL dataset.", - "properties": { - "dataType": { - "description": "Column data type.", - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN" - ], - "example": "STRING", - "type": "string" - }, - "name": { - "description": "Column name.", - "example": "ABC", - "type": "string" - } - }, - "required": [ - "dataType", - "name" - ], - "type": "object" - }, - "SwitchIdentityProviderRequest": { - "properties": { - "idpId": { - "description": "Identity provider ID to set as active for the organization.", - "example": "my-idp-123", - "type": "string" - } - }, - "required": [ - "idpId" - ], - "type": "object" - }, - "TableOverride": { - "description": "Table override settings.", - "properties": { - "columns": { - "description": "An array of column overrides", - "items": { - "$ref": "#/components/schemas/ColumnOverride" - }, - "type": "array" - }, - "path": { - "description": "Path for the table.", - "example": [ - "schema", - "table_name" - ], - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "columns", - "path" - ], - "type": "object" - }, - "TabularExportRequest": { - "description": "Export request object describing the export properties and overrides for tabular exports.", - "properties": { - "customOverride": { - "$ref": "#/components/schemas/CustomOverride" - }, - "executionResult": { - "description": "Execution result identifier.", - "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", - "type": "string" - }, - "fileName": { - "description": "Filename of downloaded file without extension.", - "example": "result", - "type": "string" - }, - "format": { - "description": "Expected file format.", - "enum": [ - "CSV", - "XLSX", - "HTML", - "PDF" - ], - "example": "CSV", - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/JsonNode" - }, - "relatedDashboardId": { - "description": "Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - "type": "string" - }, - "settings": { - "$ref": "#/components/schemas/Settings" - }, - "visualizationObject": { - "description": "Visualization object identifier. Alternative to executionResult property.", - "example": "f7c359bc-c230-4487-b15b-ad9685bcb537", - "type": "string" - }, - "visualizationObjectCustomFilters": { - "description": "Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.", - "example": "[{\"negativeAttributeFilter\":{\"displayForm\":{\"identifier\":{\"id\":\"products.category\",\"type\":\"label\"}},\"notIn\":{\"values\":[\"Books\"]}}}]", - "items": { - "type": "object" - }, - "type": "array" - } - }, - "required": [ - "fileName", - "format" - ], - "type": "object" - }, - "UserAssignee": { - "description": "List of users", - "properties": { - "email": { - "description": "User email address", - "example": "user@example.com", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "description": "User name", - "example": "John Wick", - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "UserGroupAssignee": { - "description": "List of user groups", - "properties": { - "id": { - "type": "string" - }, - "name": { - "description": "User group name", - "example": "admins", - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "UserGroupIdentifier": { - "description": "A list of groups where user is a member", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "UserGroupPermission": { - "description": "List of user groups", - "properties": { - "id": { - "type": "string" - }, - "name": { - "description": "Name of the user group", - "example": "admins", - "type": "string" - }, - "permissions": { - "description": "Permissions granted to the user group", - "items": { - "$ref": "#/components/schemas/GrantedPermission" - }, - "type": "array" + "JsonApiOrganizationSettingPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingPatch" } }, - "required": [ - "id" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "UserManagementDataSourcePermissionAssignment": { - "description": "Datasource permission assignments for users and userGroups", - "properties": { - "id": { - "description": "Id of the datasource", - "type": "string" + "JsonApiThemeIn" : { + "description" : "JSON:API representation of theme entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { }, + "type" : "object" + }, + "name" : { + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "content", "name" ], + "type" : "object" }, - "name": { - "description": "Name of the datasource", - "readOnly": true, - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "permissions": { - "items": { - "enum": [ - "MANAGE", - "USE" - ], - "type": "string" - }, - "type": "array" + "type" : { + "description" : "Object type", + "enum" : [ "theme" ], + "example" : "theme", + "type" : "string" } - }, - "required": [ - "id", - "permissions" - ], - "type": "object" + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiThemeInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiThemeIn" + } + }, + "required" : [ "data" ], + "type" : "object" }, - "UserManagementPermissionAssignments": { - "properties": { - "dataSources": { - "items": { - "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" + "JsonApiThemeOut" : { + "description" : "JSON:API representation of theme entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { }, + "type" : "object" + }, + "name" : { + "maxLength" : 255, + "type" : "string" + } }, - "type": "array" + "required" : [ "content", "name" ], + "type" : "object" }, - "workspaces": { - "items": { - "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" - }, - "type": "array" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "theme" ], + "example" : "theme", + "type" : "string" } }, - "required": [ - "dataSources", - "workspaces" - ], - "type": "object" + "required" : [ "attributes", "id", "type" ], + "type" : "object" }, - "UserManagementUserGroupMember": { - "properties": { - "id": { - "type": "string" + "JsonApiThemeOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiThemeOut" }, - "name": { - "readOnly": true, - "type": "string" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "required": [ - "id" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "UserManagementUserGroupMembers": { - "properties": { - "members": { - "items": { - "$ref": "#/components/schemas/UserManagementUserGroupMember" + "JsonApiThemeOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiThemeOutWithLinks" }, - "type": "array" - } - }, - "required": [ - "members" - ], - "type": "object" - }, - "UserManagementUserGroups": { - "properties": { - "totalCount": { - "description": "Total number of groups", - "format": "int32", - "type": "integer" + "type" : "array", + "uniqueItems" : true }, - "userGroups": { - "items": { - "$ref": "#/components/schemas/UserManagementUserGroupsItem" + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } }, - "type": "array" + "type" : "object" } }, - "required": [ - "totalCount", - "userGroups" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "UserManagementUserGroupsItem": { - "description": "List of groups", - "properties": { - "dataSources": { - "items": { - "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" + "JsonApiThemeOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiThemeOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiThemePatch" : { + "description" : "JSON:API representation of patching theme entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { }, + "type" : "object" + }, + "name" : { + "maxLength" : 255, + "type" : "string" + } }, - "type": "array" + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "id": { - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "theme" ], + "example" : "theme", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiThemePatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiThemePatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiUserDataFilterIn" : { + "description" : "JSON:API representation of userDataFilter entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "maql" : { + "maxLength" : 10000, + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "maql" ], + "type" : "object" }, - "name": { - "description": "Group name", - "example": "admins", - "type": "string" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "organizationAdmin": { - "description": "Is group organization admin", - "example": false, - "type": "boolean" - }, - "userCount": { - "description": "The number of users belonging to the group", - "format": "int32", - "type": "integer" - }, - "workspaces": { - "items": { - "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" - }, - "type": "array" - } - }, - "required": [ - "dataSources", - "id", - "organizationAdmin", - "userCount", - "workspaces" - ], - "type": "object" - }, - "UserManagementUsers": { - "properties": { - "totalCount": { - "description": "The total number of users is based on applied filters.", - "format": "int32", - "type": "integer" - }, - "users": { - "items": { - "$ref": "#/components/schemas/UserManagementUsersItem" - }, - "type": "array" - } - }, - "required": [ - "totalCount", - "users" - ], - "type": "object" - }, - "UserManagementUsersItem": { - "description": "List of users", - "properties": { - "dataSources": { - "items": { - "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" - }, - "type": "array" - }, - "email": { - "description": "User email address", - "example": "user@example.com", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "description": "User name", - "example": "John Wick", - "type": "string" - }, - "organizationAdmin": { - "description": "Is user organization admin", - "example": false, - "type": "boolean" - }, - "userGroups": { - "items": { - "$ref": "#/components/schemas/UserGroupIdentifier" - }, - "type": "array" - }, - "workspaces": { - "items": { - "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" - }, - "type": "array" - } - }, - "required": [ - "dataSources", - "id", - "organizationAdmin", - "userGroups", - "workspaces" - ], - "type": "object" - }, - "UserManagementWorkspacePermissionAssignment": { - "description": "Workspace permission assignments for users and userGroups", - "properties": { - "hierarchyPermissions": { - "items": { - "enum": [ - "MANAGE", - "ANALYZE", - "EXPORT", - "EXPORT_TABULAR", - "EXPORT_PDF", - "CREATE_AUTOMATION", - "USE_AI_ASSISTANT", - "CREATE_FILTER_VIEW", - "VIEW" - ], - "type": "string" - }, - "type": "array" - }, - "id": { - "type": "string" - }, - "name": { - "readOnly": true, - "type": "string" - }, - "permissions": { - "items": { - "enum": [ - "MANAGE", - "ANALYZE", - "EXPORT", - "EXPORT_TABULAR", - "EXPORT_PDF", - "CREATE_AUTOMATION", - "USE_AI_ASSISTANT", - "CREATE_FILTER_VIEW", - "VIEW" - ], - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "hierarchyPermissions", - "id", - "permissions" - ], - "type": "object" - }, - "UserPermission": { - "description": "List of users", - "properties": { - "email": { - "description": "User email address", - "example": "user@example.com", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "description": "Name of user", - "example": "John Wick", - "type": "string" - }, - "permissions": { - "description": "Permissions granted to the user", - "items": { - "$ref": "#/components/schemas/GrantedPermission" - }, - "type": "array" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "Value": { - "properties": { - "value": { - "description": "Value of the alert threshold to compare the metric to.", - "example": 1000, - "type": "number" - } - }, - "required": [ - "value" - ], - "type": "object" - }, - "VisibleFilter": { - "properties": { - "isAllTimeDateFilter": { - "default": false, - "description": "Indicates if the filter is an all-time date filter. Such a filter is not included in report computation, so there is no filter with the same 'localIdentifier' to be found. In such cases, this flag is used to inform the server to not search for the filter in the definitions and include it anyways.", - "type": "boolean" - }, - "localIdentifier": { - "type": "string" - }, - "title": { - "type": "string" - } - }, - "type": "object" - }, - "VisualExportRequest": { - "description": "Export request object describing the export properties and metadata for dashboard PDF exports.", - "properties": { - "dashboardId": { - "description": "Dashboard identifier", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - "type": "string" - }, - "fileName": { - "description": "File name to be used for retrieving the pdf document.", - "example": "filename", - "type": "string" - }, - "metadata": { - "description": "Metadata definition in free-form JSON format.", - "example": "{}", - "type": "object" - } - }, - "required": [ - "dashboardId", - "fileName" - ], - "type": "object" - }, - "Webhook": { - "allOf": [ - { - "properties": { - "hasSecretKey": { - "description": "Flag indicating if webhook has a hmac secret key.", - "maxLength": 10000, - "nullable": true, - "readOnly": true, - "type": "boolean" - }, - "hasToken": { - "description": "Flag indicating if webhook has a token.", - "maxLength": 10000, - "nullable": true, - "readOnly": true, - "type": "boolean" - }, - "secretKey": { - "description": "Hmac secret key for the webhook signature.", - "example": "secret_key", - "maxLength": 10000, - "nullable": true, - "type": "string", - "writeOnly": true - }, - "token": { - "description": "Bearer token for the webhook.", - "example": "secret", - "maxLength": 10000, - "nullable": true, - "type": "string", - "writeOnly": true - }, - "type": { - "description": "The destination type.", - "enum": [ - "WEBHOOK" - ], - "type": "string" - }, - "url": { - "description": "The webhook URL.", - "example": "https://webhook.site/something", - "maxLength": 255, - "pattern": "https?\\://.*", - "type": "string" - } - }, - "type": "object" - } - ], - "description": "Webhook destination for notifications. The property url is required on create and update.", - "required": [ - "type" - ], - "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, - "properties": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], - "items": { - "enum": [ - "PDF", - "PPTX" - ], - "type": "string" - }, - "minItems": 1, - "type": "array" - }, - "contentSlide": { - "$ref": "#/components/schemas/ContentSlideTemplate" - } - }, - "required": [ - "appliedOn" - ], - "type": "object" - }, - "WorkspaceAutomationIdentifier": { - "properties": { - "id": { - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "WorkspaceAutomationManagementBulkRequest": { - "properties": { - "automations": { - "items": { - "$ref": "#/components/schemas/WorkspaceAutomationIdentifier" - }, - "type": "array" - } - }, - "required": [ - "automations" - ], - "type": "object" - }, - "WorkspaceDataSource": { - "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", - "properties": { - "id": { - "description": "The ID of the used data source.", - "example": "snowflake.instance.1", - "type": "string" - }, - "schemaPath": { - "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", - "items": { - "description": "The part of the schema path.", - "example": "subPath", - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "WorkspaceIdentifier": { - "description": "A workspace identifier.", - "example": "{ id: demo, type: workspace }", - "properties": { - "id": { - "description": "Identifier of the workspace.", - "example": "alpha.sales", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "A type.", - "enum": [ - "workspace" - ], - "example": "workspace", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "WorkspacePermissionAssignment": { - "description": "Workspace permission assignments", - "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" - }, - "hierarchyPermissions": { - "items": { - "enum": [ - "MANAGE", - "ANALYZE", - "EXPORT", - "EXPORT_TABULAR", - "EXPORT_PDF", - "CREATE_AUTOMATION", - "USE_AI_ASSISTANT", - "CREATE_FILTER_VIEW", - "VIEW" - ], - "type": "string" - }, - "type": "array" - }, - "permissions": { - "items": { - "enum": [ - "MANAGE", - "ANALYZE", - "EXPORT", - "EXPORT_TABULAR", - "EXPORT_PDF", - "CREATE_AUTOMATION", - "USE_AI_ASSISTANT", - "CREATE_FILTER_VIEW", - "VIEW" - ], - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "assigneeIdentifier" - ], - "type": "object" - }, - "WorkspaceUser": { - "description": "List of workspace users", - "properties": { - "email": { - "description": "User email address", - "example": "user@example.com", - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "description": "User name", - "example": "John Wick", - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "WorkspaceUserGroup": { - "description": "List of workspace groups", - "properties": { - "id": { - "type": "string" - }, - "name": { - "description": "Group name", - "example": "admins", - "type": "string" - } - }, - "required": [ - "id" - ], - "type": "object" - }, - "WorkspaceUserGroups": { - "properties": { - "totalCount": { - "description": "Total number of groups", - "format": "int32", - "type": "integer" - }, - "userGroups": { - "items": { - "$ref": "#/components/schemas/WorkspaceUserGroup" - }, - "type": "array" - } - }, - "required": [ - "totalCount", - "userGroups" - ], - "type": "object" - }, - "WorkspaceUsers": { - "properties": { - "totalCount": { - "description": "The total number of users is based on applied filters.", - "format": "int32", - "type": "integer" - }, - "users": { - "items": { - "$ref": "#/components/schemas/WorkspaceUser" + "relationships" : { + "properties" : { + "user" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "userGroup" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserGroupToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } }, - "type": "array" + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "userDataFilter" ], + "example" : "userDataFilter", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiUserDataFilterInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterIn" } }, - "required": [ - "totalCount", - "users" - ], - "type": "object" + "required" : [ "data" ], + "type" : "object" }, - "Xliff": { - "properties": { - "file": { - "items": { - "$ref": "#/components/schemas/File" + "JsonApiUserDataFilterOut" : { + "description" : "JSON:API representation of userDataFilter entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "maql" : { + "maxLength" : 10000, + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } }, - "type": "array" + "required" : [ "maql" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "otherAttributes": { - "additionalProperties": { - "type": "string" + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" + }, + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" + } + }, + "required" : [ "originId", "originType" ], + "type" : "object" + } }, - "type": "object" + "type" : "object" }, - "space": { - "type": "string" + "relationships" : { + "properties" : { + "attributes" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAttributeToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "datasets" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDatasetToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "facts" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiFactToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "labels" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiLabelToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "metrics" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiMetricToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "user" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "userGroup" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserGroupToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" }, - "srcLang": { - "type": "string" + "type" : { + "description" : "Object type", + "enum" : [ "userDataFilter" ], + "example" : "userDataFilter", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiUserDataFilterOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterOut" }, - "trgLang": { - "type": "string" + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterOutIncludes" + }, + "type" : "array", + "uniqueItems" : true }, - "version": { - "type": "string" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "type": "object" - } - } - }, - "info": { - "title": "OpenAPI definition", - "version": "v0" - }, - "openapi": "3.0.1", - "paths": { - "/api/v1/aac/workspaces/{workspaceId}/analyticsModel": { - "get": { - "description": "\n Retrieve the analytics model of the workspace in Analytics as Code format.\n \n The returned format is compatible with the YAML definitions used by the \n GoodData Analytics as Code VSCode extension. This includes metrics, \n dashboards, visualizations, plugins, and attribute hierarchies.\n ", - "operationId": "getAnalyticsModelAac", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiUserDataFilterOutIncludes" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiUserOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiFactOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiAttributeOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiLabelOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiMetricOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiDatasetOutWithLinks" + } ] + }, + "JsonApiUserDataFilterOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true }, - { - "in": "query", - "name": "exclude", - "required": false, - "schema": { - "items": { - "description": "Defines properties which should not be included in the payload.", - "enum": [ - "ACTIVITY_INFO" - ], - "type": "string" - }, - "type": "array" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AacAnalyticsModel" - } + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterOutIncludes" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "description": "Retrieved current analytics model in AAC format." + "type" : "object" } }, - "summary": "Get analytics model in AAC format", - "tags": [ - "aac", - "AAC - Analytics Model" - ], - "x-gdc-security-info": { - "description": "Permissions to read the analytics layout.", - "permissions": [ - "ANALYZE" - ] - } + "required" : [ "data" ], + "type" : "object" }, - "put": { - "description": "\n Set the analytics model of the workspace using Analytics as Code format.\n \n The input format is compatible with the YAML definitions used by the \n GoodData Analytics as Code VSCode extension. This replaces the entire \n analytics model with the provided definition, including metrics, \n dashboards, visualizations, plugins, and attribute hierarchies.\n ", - "operationId": "setAnalyticsModelAac", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AacAnalyticsModel" + "JsonApiUserDataFilterOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiUserDataFilterOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiUserDataFilterPatch" : { + "description" : "JSON:API representation of patching userDataFilter entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "maql" : { + "maxLength" : 10000, + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "user" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "userGroup" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserGroupToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" } - } + }, + "type" : "object" }, - "required": true + "type" : { + "description" : "Object type", + "enum" : [ "userDataFilter" ], + "example" : "userDataFilter", + "type" : "string" + } }, - "responses": { - "204": { - "description": "Analytics model successfully set." + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiUserDataFilterPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterPatch" } }, - "summary": "Set analytics model from AAC format", - "tags": [ - "aac", - "AAC - Analytics Model" - ], - "x-gdc-security-info": { - "description": "Permissions to modify the analytics layout.", - "permissions": [ - "ANALYZE" - ] - } - } - }, - "/api/v1/aac/workspaces/{workspaceId}/logicalModel": { - "get": { - "description": "\n Retrieve the logical data model of the workspace in Analytics as Code format.\n \n The returned format is compatible with the YAML definitions used by the \n GoodData Analytics as Code VSCode extension. Use this for exporting models\n that can be directly used as YAML configuration files.\n ", - "operationId": "getLogicalModelAac", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiUserDataFilterPostOptionalId" : { + "description" : "JSON:API representation of userDataFilter entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "maql" : { + "maxLength" : 10000, + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "maql" ], + "type" : "object" }, - { - "in": "query", - "name": "includeParents", - "required": false, - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AacLogicalModel" - } + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "user" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "userGroup" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserGroupToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" } }, - "description": "Retrieved current logical model in AAC format." + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "userDataFilter" ], + "example" : "userDataFilter", + "type" : "string" } }, - "summary": "Get logical model in AAC format", - "tags": [ - "aac", - "AAC - Logical Data Model" - ], - "x-gdc-security-info": { - "description": "Permissions to read the logical model.", - "permissions": [ - "VIEW" - ] - } + "required" : [ "attributes", "type" ], + "type" : "object" }, - "put": { - "description": "\n Set the logical data model of the workspace using Analytics as Code format.\n \n The input format is compatible with the YAML definitions used by the \n GoodData Analytics as Code VSCode extension. This replaces the entire \n logical model with the provided definition.\n ", - "operationId": "setLogicalModelAac", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "JsonApiUserDataFilterPostOptionalIdDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterPostOptionalId" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AacLogicalModel" + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiUserGroupIn" : { + "description" : "JSON:API representation of userGroup entity.", + "properties" : { + "attributes" : { + "properties" : { + "name" : { + "maxLength" : 255, + "type" : "string" } - } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "parents" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserGroupToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" }, - "required": true + "type" : { + "description" : "Object type", + "enum" : [ "userGroup" ], + "example" : "userGroup", + "type" : "string" + } }, - "responses": { - "204": { - "description": "Logical model successfully set." + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiUserGroupInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserGroupIn" } }, - "summary": "Set logical model from AAC format", - "tags": [ - "aac", - "AAC - Logical Data Model" - ], - "x-gdc-security-info": { - "description": "Permissions required to alter the logical model.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/collectUsage": { - "get": { - "description": "Provides information about platform usage, like amount of users, workspaces, ...\n\n_NOTE_: The `admin` user is always excluded from this amount.", - "operationId": "allPlatformUsage", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/PlatformUsage" - }, - "type": "array" - } - } - }, - "description": "OK" + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiUserGroupLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "userGroup" ], + "type" : "string" } }, - "summary": "Info about the platform usage.", - "tags": [ - "Usage", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + "required" : [ "id", "type" ], + "type" : "object" }, - "post": { - "description": "Provides information about platform usage, like amount of users, workspaces, ...\n\n_NOTE_: The `admin` user is always excluded from this amount.", - "operationId": "particularPlatformUsage", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PlatformUsageRequest" + "JsonApiUserGroupOut" : { + "description" : "JSON:API representation of userGroup entity.", + "properties" : { + "attributes" : { + "properties" : { + "name" : { + "maxLength" : 255, + "type" : "string" } - } + }, + "type" : "object" }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/PlatformUsage" - }, - "type": "array" - } + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "parents" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserGroupToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" } }, - "description": "OK" + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "userGroup" ], + "example" : "userGroup", + "type" : "string" } }, - "summary": "Info about the platform usage for particular items.", - "tags": [ - "Usage", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel": { - "post": { - "description": "Generate logical data model (LDM) from physical data model (PDM) stored in data source.", - "operationId": "generateLogicalModel", - "parameters": [ - { - "in": "path", - "name": "dataSourceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenerateLdmRequest" - } - } + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiUserGroupOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserGroupOut" + }, + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true }, - "required": true + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" + } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeModel" - } + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiUserGroupOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "description": "LDM generated successfully." + "type" : "object" } }, - "summary": "Generate logical data model (LDM) from physical data model (PDM)", - "tags": [ - "Generate Logical Data Model", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/dataSources/{dataSourceId}/generateLogicalModelAac": { - "post": { - "description": "\n Generate logical data model (LDM) from physical data model (PDM) stored in data source,\n returning the result in Analytics as Code (AAC) format compatible with the GoodData \n VSCode extension YAML definitions.\n ", - "operationId": "generateLogicalModelAac", - "parameters": [ - { - "in": "path", - "name": "dataSourceId", - "required": true, - "schema": { - "type": "string" - } + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiUserGroupOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiUserGroupOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiUserGroupPatch" : { + "description" : "JSON:API representation of patching userGroup entity.", + "properties" : { + "attributes" : { + "properties" : { + "name" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "parents" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserGroupToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "userGroup" ], + "example" : "userGroup", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiUserGroupPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserGroupPatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiUserGroupToManyLinkage" : { + "description" : "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items" : { + "$ref" : "#/components/schemas/JsonApiUserGroupLinkage" + }, + "type" : "array" + }, + "JsonApiUserGroupToOneLinkage" : { + "description" : "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiUserGroupLinkage" + } ] + }, + "JsonApiUserIdentifierLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "userIdentifier" ], + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenerateLdmRequest" + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiUserIdentifierOut" : { + "description" : "JSON:API representation of userIdentifier entity.", + "properties" : { + "attributes" : { + "properties" : { + "email" : { + "maxLength" : 255, + "type" : "string" + }, + "firstname" : { + "maxLength" : 255, + "type" : "string" + }, + "lastname" : { + "maxLength" : 255, + "type" : "string" } - } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "userIdentifier" ], + "example" : "userIdentifier", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiUserIdentifierOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierOut" }, - "required": true + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" + } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AacLogicalModel" - } + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiUserIdentifierOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "description": "LDM generated successfully in AAC format." + "type" : "object" } }, - "summary": "Generate logical data model in AAC format from physical data model (PDM)", - "tags": [ - "Generate Logical Data Model", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/dataSources/{dataSourceId}/managePermissions": { - "post": { - "description": "Manage Permissions for a Data Source", - "operationId": "manageDataSourcePermissions", - "parameters": [ - { - "in": "path", - "name": "dataSourceId", - "required": true, - "schema": { - "type": "string" - } + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiUserIdentifierOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiUserIdentifierOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiUserIdentifierToOneLinkage" : { + "description" : "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiUserIdentifierLinkage" + } ] + }, + "JsonApiUserIn" : { + "description" : "JSON:API representation of user entity.", + "properties" : { + "attributes" : { + "properties" : { + "authenticationId" : { + "maxLength" : 255, + "type" : "string" + }, + "email" : { + "maxLength" : 255, + "type" : "string" + }, + "firstname" : { + "maxLength" : 255, + "type" : "string" + }, + "lastname" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "userGroups" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserGroupToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "user" ], + "example" : "user", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiUserInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiUserLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "user" ], + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "An array of data source permissions assignments", - "items": { - "$ref": "#/components/schemas/DataSourcePermissionAssignment" + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiUserOut" : { + "description" : "JSON:API representation of user entity.", + "properties" : { + "attributes" : { + "properties" : { + "authenticationId" : { + "maxLength" : 255, + "type" : "string" + }, + "email" : { + "maxLength" : 255, + "type" : "string" + }, + "firstname" : { + "maxLength" : 255, + "type" : "string" + }, + "lastname" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "userGroups" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserGroupToManyLinkage" + } }, - "type": "array" + "required" : [ "data" ], + "type" : "object" } - } + }, + "type" : "object" }, - "required": true + "type" : { + "description" : "Object type", + "enum" : [ "user" ], + "example" : "user", + "type" : "string" + } }, - "responses": { - "204": { - "description": "No Content" + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiUserOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserOut" + }, + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "summary": "Manage Permissions for a Data Source", - "tags": [ - "Manage Permissions", - "Permissions", - "actions" - ] - } - }, - "/api/v1/actions/dataSources/{dataSourceId}/uploadNotification": { - "post": { - "description": "Notification sets up all reports to be computed again with new data.", - "operationId": "registerUploadNotification", - "parameters": [ - { - "in": "path", - "name": "dataSourceId", - "required": true, - "schema": { - "type": "string" - } + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiUserOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiUserOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } + }, + "type" : "object" } - ], - "responses": { - "204": { - "description": "An upload notification has been successfully registered." - } - }, - "summary": "Register an upload notification", - "tags": [ - "Invalidate Cache", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/organization/automations/delete": { - "post": { - "operationId": "deleteOrganizationAutomations", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiUserOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiUserOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiUserPatch" : { + "description" : "JSON:API representation of patching user entity.", + "properties" : { + "attributes" : { + "properties" : { + "authenticationId" : { + "maxLength" : 255, + "type" : "string" + }, + "email" : { + "maxLength" : 255, + "type" : "string" + }, + "firstname" : { + "maxLength" : 255, + "type" : "string" + }, + "lastname" : { + "maxLength" : 255, + "type" : "string" } - } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "userGroups" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserGroupToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" }, - "required": true + "type" : { + "description" : "Object type", + "enum" : [ "user" ], + "example" : "user", + "type" : "string" + } }, - "responses": { - "204": { - "description": "No Content" + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiUserPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserPatch" } }, - "summary": "Delete selected automations across all workspaces", - "tags": [ - "Automations", - "actions" - ] - } - }, - "/api/v1/actions/organization/automations/pause": { - "post": { - "operationId": "pauseOrganizationAutomations", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiUserSettingIn" : { + "description" : "JSON:API representation of userSetting entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { }, + "type" : "object" + }, + "type" : { + "enum" : [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS" ], + "type" : "string" } - } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "required": true + "type" : { + "description" : "Object type", + "enum" : [ "userSetting" ], + "example" : "userSetting", + "type" : "string" + } }, - "responses": { - "204": { - "description": "No Content" + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiUserSettingInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserSettingIn" } }, - "summary": "Pause selected automations across all workspaces", - "tags": [ - "Automations", - "actions" - ] - } - }, - "/api/v1/actions/organization/automations/unpause": { - "post": { - "operationId": "unpauseOrganizationAutomations", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiUserSettingOut" : { + "description" : "JSON:API representation of userSetting entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { }, + "type" : "object" + }, + "type" : { + "enum" : [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS" ], + "type" : "string" } - } + }, + "type" : "object" }, - "required": true + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "userSetting" ], + "example" : "userSetting", + "type" : "string" + } }, - "responses": { - "204": { - "description": "No Content" + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiUserSettingOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserSettingOut" + }, + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "summary": "Unpause selected automations across all workspaces", - "tags": [ - "Automations", - "actions" - ] - } - }, - "/api/v1/actions/organization/automations/unsubscribe": { - "delete": { - "operationId": "unsubscribeAllAutomations", - "responses": { - "204": { - "description": "No Content" - } - }, - "summary": "Unsubscribe from all automations in all workspaces", - "tags": [ - "Automations", - "actions" - ] - }, - "post": { - "operationId": "unsubscribeOrganizationAutomations", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiUserSettingOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiUserSettingOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } - } + }, + "type" : "object" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiUserSettingOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiUserSettingOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiUserToManyLinkage" : { + "description" : "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items" : { + "$ref" : "#/components/schemas/JsonApiUserLinkage" + }, + "type" : "array" + }, + "JsonApiUserToOneLinkage" : { + "description" : "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiUserLinkage" + } ] + }, + "JsonApiVisualizationObjectIn" : { + "description" : "JSON:API representation of visualizationObject entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { + "identifier" : { + "id" : "label.leaf", + "type" : "label" + }, + "someBoolProp" : false + }, + "type" : "object" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "isHidden" : { + "type" : "boolean" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "content" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" }, - "required": true + "type" : { + "description" : "Object type", + "enum" : [ "visualizationObject" ], + "example" : "visualizationObject", + "type" : "string" + } + }, + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiVisualizationObjectInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectIn" + } }, - "responses": { - "204": { - "description": "No Content" + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiVisualizationObjectLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "visualizationObject" ], + "type" : "string" } }, - "summary": "Unsubscribe from selected automations across all workspaces", - "tags": [ - "Automations", - "actions" - ] - } - }, - "/api/v1/actions/organization/managePermissions": { - "post": { - "description": "Manage Permissions for a Organization", - "operationId": "manageOrganizationPermissions", - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "An array of organization permissions assignments", - "items": { - "$ref": "#/components/schemas/OrganizationPermissionAssignment" - }, - "type": "array" + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiVisualizationObjectOut" : { + "description" : "JSON:API representation of visualizationObject entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { + "identifier" : { + "id" : "label.leaf", + "type" : "label" + }, + "someBoolProp" : false + }, + "type" : "object" + }, + "createdAt" : { + "description" : "Time of the entity creation.", + "format" : "date-time", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "isHidden" : { + "type" : "boolean" + }, + "modifiedAt" : { + "description" : "Time of the last entity modification.", + "format" : "date-time", + "nullable" : true, + "pattern" : "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type" : "string" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "content" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" + }, + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" + } + }, + "required" : [ "originId", "originType" ], + "type" : "object" } - } + }, + "type" : "object" + }, + "relationships" : { + "properties" : { + "attributes" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAttributeToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "createdBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "datasets" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiDatasetToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "facts" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiFactToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "labels" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiLabelToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "metrics" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiMetricToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "modifiedBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" }, - "required": true + "type" : { + "description" : "Object type", + "enum" : [ "visualizationObject" ], + "example" : "visualizationObject", + "type" : "string" + } }, - "responses": { - "204": { - "description": "No Content" + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiVisualizationObjectOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectOut" + }, + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiMetricOutIncludes" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "summary": "Manage Permissions for a Organization", - "tags": [ - "Permissions", - "actions" - ] - } - }, - "/api/v1/actions/organization/metadataCheck": { - "post": { - "description": "(BETA) Temporary solution. Resyncs all organization objects and full workspaces within the organization with target GEN_AI_CHECK.", - "operationId": "metadataCheckOrganization", - "responses": { - "200": { - "description": "OK" - } - }, - "summary": "(BETA) Check Organization Metadata Inconsistencies", - "tags": [ - "AI", - "Metadata Check", - "actions" - ] - } - }, - "/api/v1/actions/organization/metadataSync": { - "post": { - "description": "(BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only.", - "operationId": "metadataSyncOrganization", - "responses": { - "200": { - "description": "OK" - } - }, - "summary": "(BETA) Sync organization scope Metadata to other services", - "tags": [ - "AI", - "Metadata Sync", - "actions" - ] - } - }, - "/api/v1/actions/organization/switchActiveIdentityProvider": { - "post": { - "description": "Switch the active identity provider for the organization. Requires MANAGE permission on the organization.", - "operationId": "switchActiveIdentityProvider", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SwitchIdentityProviderRequest" + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiVisualizationObjectOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiMetricOutIncludes" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } - } + }, + "type" : "object" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiVisualizationObjectOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiVisualizationObjectPatch" : { + "description" : "JSON:API representation of patching visualizationObject entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { + "identifier" : { + "id" : "label.leaf", + "type" : "label" + }, + "someBoolProp" : false + }, + "type" : "object" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "isHidden" : { + "type" : "boolean" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" }, - "required": true + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "visualizationObject" ], + "example" : "visualizationObject", + "type" : "string" + } }, - "responses": { - "204": { - "description": "No Content" + "required" : [ "attributes", "id", "type" ], + "type" : "object" + }, + "JsonApiVisualizationObjectPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectPatch" } }, - "summary": "Switch Active Identity Provider", - "tags": [ - "Organization", - "actions" - ] - } - }, - "/api/v1/actions/resolveEntitlements": { - "get": { - "description": "Resolves values of available entitlements for the organization.", - "operationId": "resolveAllEntitlements", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/ApiEntitlement" + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiVisualizationObjectPostOptionalId" : { + "description" : "JSON:API representation of visualizationObject entity.", + "properties" : { + "attributes" : { + "properties" : { + "areRelationsValid" : { + "type" : "boolean" + }, + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 250000 characters.", + "example" : { + "identifier" : { + "id" : "label.leaf", + "type" : "label" }, - "type": "array" - } + "someBoolProp" : false + }, + "type" : "object" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "isHidden" : { + "type" : "boolean" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" } }, - "description": "OK" + "required" : [ "content" ], + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "visualizationObject" ], + "example" : "visualizationObject", + "type" : "string" + } + }, + "required" : [ "attributes", "type" ], + "type" : "object" + }, + "JsonApiVisualizationObjectPostOptionalIdDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectPostOptionalId" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiVisualizationObjectToManyLinkage" : { + "description" : "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectLinkage" + }, + "type" : "array" + }, + "JsonApiVisualizationObjectToOneLinkage" : { + "description" : "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectLinkage" + } ] + }, + "JsonApiWorkspaceAutomationOut" : { + "description" : "JSON:API representation of workspaceAutomation entity.", + "properties" : { + "attributes" : { + "properties" : { + "alert" : { + "properties" : { + "condition" : { + "$ref" : "#/components/schemas/AlertCondition" + }, + "execution" : { + "$ref" : "#/components/schemas/AlertAfm" + }, + "interval" : { + "description" : "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", + "enum" : [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], + "type" : "string" + }, + "trigger" : { + "default" : "ALWAYS", + "description" : "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", + "enum" : [ "ALWAYS", "ONCE", "ONCE_PER_INTERVAL" ], + "type" : "string" + } + }, + "required" : [ "condition", "execution" ], + "type" : "object" + }, + "areRelationsValid" : { + "type" : "boolean" + }, + "createdAt" : { + "format" : "date-time", + "type" : "string" + }, + "dashboardTabularExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/DashboardTabularExportRequestV2" + } + }, + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "details" : { + "description" : "Additional details to be included in the automated message.", + "maxLength" : 10000, + "type" : "object" + }, + "evaluationMode" : { + "description" : "Specify automation evaluation mode.", + "enum" : [ "SHARED", "PER_RECIPIENT" ], + "type" : "string" + }, + "externalRecipients" : { + "description" : "External recipients of the automation action results.", + "items" : { + "properties" : { + "email" : { + "description" : "E-mail address to send notifications from.", + "format" : "email", + "type" : "string" + } + }, + "required" : [ "email" ], + "type" : "object" + }, + "type" : "array" + }, + "imageExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/ImageExportRequest" + } + }, + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + }, + "metadata" : { + "description" : "Additional information for the automation.", + "maxLength" : 250000, + "nullable" : true, + "properties" : { + "visibleFilters" : { + "items" : { + "$ref" : "#/components/schemas/VisibleFilter" + }, + "type" : "array" + }, + "widget" : { + "type" : "string" + } + }, + "type" : "object" + }, + "modifiedAt" : { + "format" : "date-time", + "type" : "string" + }, + "rawExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/RawExportAutomationRequest" + } + }, + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + }, + "schedule" : { + "properties" : { + "cron" : { + "description" : "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", + "example" : "0 */30 9-17 ? * MON-FRI", + "maxLength" : 255, + "type" : "string" + }, + "cronDescription" : { + "description" : "Human-readable description of the cron expression.", + "readOnly" : true, + "type" : "string" + }, + "firstRun" : { + "description" : "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", + "example" : "2025-01-01T12:00:00Z", + "format" : "date-time", + "type" : "string" + }, + "timezone" : { + "description" : "Timezone in which the schedule is defined.", + "example" : "Europe/Prague", + "maxLength" : 255, + "type" : "string" + } + }, + "required" : [ "cron", "timezone" ], + "type" : "object" + }, + "slidesExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/SlidesExportRequest" + } + }, + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + }, + "state" : { + "description" : "Current state of the automation.", + "enum" : [ "ACTIVE", "PAUSED" ], + "type" : "string" + }, + "tabularExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/TabularExportRequest" + } + }, + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + }, + "tags" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + }, + "visualExports" : { + "items" : { + "properties" : { + "requestPayload" : { + "$ref" : "#/components/schemas/VisualExportRequest" + } + }, + "required" : [ "requestPayload" ], + "type" : "object" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "analyticalDashboard" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "automationResults" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiAutomationResultToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "createdBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "exportDefinitions" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "modifiedBy" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "notificationChannel" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "recipients" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiUserToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "workspace" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "workspaceAutomation" ], + "example" : "workspaceAutomation", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiWorkspaceAutomationOutIncludes" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiWorkspaceOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiNotificationChannelOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiUserOutWithLinks" + }, { + "$ref" : "#/components/schemas/JsonApiAutomationResultOutWithLinks" + } ] + }, + "JsonApiWorkspaceAutomationOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceAutomationOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceAutomationOutIncludes" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } + }, + "type" : "object" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiWorkspaceAutomationOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiWorkspaceAutomationOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiWorkspaceDataFilterIn" : { + "description" : "JSON:API representation of workspaceDataFilter entity.", + "properties" : { + "attributes" : { + "properties" : { + "columnName" : { + "maxLength" : 255, + "type" : "string" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "filterSettings" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "workspaceDataFilter" ], + "example" : "workspaceDataFilter", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiWorkspaceDataFilterInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiWorkspaceDataFilterLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "workspaceDataFilter" ], + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiWorkspaceDataFilterOut" : { + "description" : "JSON:API representation of workspaceDataFilter entity.", + "properties" : { + "attributes" : { + "properties" : { + "columnName" : { + "maxLength" : 255, + "type" : "string" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" + }, + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" + } + }, + "required" : [ "originId", "originType" ], + "type" : "object" + } + }, + "type" : "object" + }, + "relationships" : { + "properties" : { + "filterSettings" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "workspaceDataFilter" ], + "example" : "workspaceDataFilter", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiWorkspaceDataFilterOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOut" + }, + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiWorkspaceDataFilterOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } + }, + "type" : "object" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiWorkspaceDataFilterOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiWorkspaceDataFilterPatch" : { + "description" : "JSON:API representation of patching workspaceDataFilter entity.", + "properties" : { + "attributes" : { + "properties" : { + "columnName" : { + "maxLength" : 255, + "type" : "string" + }, + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "filterSettings" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "workspaceDataFilter" ], + "example" : "workspaceDataFilter", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiWorkspaceDataFilterPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterPatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiWorkspaceDataFilterSettingIn" : { + "description" : "JSON:API representation of workspaceDataFilterSetting entity.", + "properties" : { + "attributes" : { + "properties" : { + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "filterValues" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "workspaceDataFilter" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "workspaceDataFilterSetting" ], + "example" : "workspaceDataFilterSetting", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiWorkspaceDataFilterSettingInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiWorkspaceDataFilterSettingLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "workspaceDataFilterSetting" ], + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiWorkspaceDataFilterSettingOut" : { + "description" : "JSON:API representation of workspaceDataFilterSetting entity.", + "properties" : { + "attributes" : { + "properties" : { + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "filterValues" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" + }, + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" + } + }, + "required" : [ "originId", "originType" ], + "type" : "object" + } + }, + "type" : "object" + }, + "relationships" : { + "properties" : { + "workspaceDataFilter" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "workspaceDataFilterSetting" ], + "example" : "workspaceDataFilterSetting", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiWorkspaceDataFilterSettingOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" + }, + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiWorkspaceDataFilterSettingOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" + } + }, + "type" : "object" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiWorkspaceDataFilterSettingOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiWorkspaceDataFilterSettingPatch" : { + "description" : "JSON:API representation of patching workspaceDataFilterSetting entity.", + "properties" : { + "attributes" : { + "properties" : { + "description" : { + "maxLength" : 10000, + "type" : "string" + }, + "filterValues" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "title" : { + "maxLength" : 255, + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "workspaceDataFilter" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "workspaceDataFilterSetting" ], + "example" : "workspaceDataFilterSetting", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiWorkspaceDataFilterSettingPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatch" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiWorkspaceDataFilterSettingToManyLinkage" : { + "description" : "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingLinkage" + }, + "type" : "array" + }, + "JsonApiWorkspaceDataFilterToManyLinkage" : { + "description" : "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "items" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterLinkage" + }, + "type" : "array" + }, + "JsonApiWorkspaceDataFilterToOneLinkage" : { + "description" : "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterLinkage" + } ] + }, + "JsonApiWorkspaceIn" : { + "description" : "JSON:API representation of workspace entity.", + "properties" : { + "attributes" : { + "properties" : { + "cacheExtraLimit" : { + "format" : "int64", + "type" : "integer" + }, + "dataSource" : { + "description" : "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", + "properties" : { + "id" : { + "description" : "The ID of the used data source.", + "example" : "snowflake.instance.1", + "type" : "string" + }, + "schemaPath" : { + "description" : "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", + "items" : { + "description" : "The part of the schema path.", + "example" : "subPath", + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "description" : { + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "earlyAccess" : { + "deprecated" : true, + "description" : "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "earlyAccessValues" : { + "description" : "The early access feature identifiers. They are used to enable experimental features.", + "items" : { + "maxLength" : 255, + "type" : "string" + }, + "nullable" : true, + "type" : "array" + }, + "name" : { + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "prefix" : { + "description" : "Custom prefix of entity identifiers in workspace", + "maxLength" : 255, + "nullable" : true, + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "parent" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "workspace" ], + "example" : "workspace", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiWorkspaceInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceIn" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiWorkspaceLinkage" : { + "description" : "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties" : { + "id" : { + "type" : "string" + }, + "type" : { + "enum" : [ "workspace" ], + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiWorkspaceOut" : { + "description" : "JSON:API representation of workspace entity.", + "properties" : { + "attributes" : { + "properties" : { + "cacheExtraLimit" : { + "format" : "int64", + "type" : "integer" + }, + "dataSource" : { + "description" : "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", + "properties" : { + "id" : { + "description" : "The ID of the used data source.", + "example" : "snowflake.instance.1", + "type" : "string" + }, + "schemaPath" : { + "description" : "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", + "items" : { + "description" : "The part of the schema path.", + "example" : "subPath", + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "description" : { + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "earlyAccess" : { + "deprecated" : true, + "description" : "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "earlyAccessValues" : { + "description" : "The early access feature identifiers. They are used to enable experimental features.", + "items" : { + "maxLength" : 255, + "type" : "string" + }, + "nullable" : true, + "type" : "array" + }, + "name" : { + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "prefix" : { + "description" : "Custom prefix of entity identifiers in workspace", + "maxLength" : 255, + "nullable" : true, + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "meta" : { + "properties" : { + "config" : { + "properties" : { + "approximateCountAvailable" : { + "default" : false, + "description" : "is approximate count enabled - based on type of data-source connected to this workspace", + "type" : "boolean" + }, + "dataSamplingAvailable" : { + "default" : false, + "description" : "is sampling enabled - based on type of data-source connected to this workspace", + "type" : "boolean" + }, + "showAllValuesOnDatesAvailable" : { + "default" : false, + "description" : "is 'show all values' displayed for dates - based on type of data-source connected to this workspace", + "type" : "boolean" + } + }, + "type" : "object" + }, + "dataModel" : { + "properties" : { + "datasetCount" : { + "description" : "include the number of dataset of each workspace", + "format" : "int32", + "type" : "integer" + } + }, + "required" : [ "datasetCount" ], + "type" : "object" + }, + "hierarchy" : { + "properties" : { + "childrenCount" : { + "description" : "include the number of direct children of each workspace", + "format" : "int32", + "type" : "integer" + } + }, + "required" : [ "childrenCount" ], + "type" : "object" + }, + "permissions" : { + "description" : "List of valid permissions for a logged-in user.", + "items" : { + "enum" : [ "MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "CREATE_FILTER_VIEW", "VIEW" ], + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "relationships" : { + "properties" : { + "parent" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" + } + }, + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "workspace" ], + "example" : "workspace", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiWorkspaceOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceOut" + }, + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "summary": "Values for all public entitlements.", - "tags": [ - "Entitlement", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "VIEW" - ] - } + "required" : [ "data" ], + "type" : "object" }, - "post": { - "description": "Resolves values for requested entitlements in the organization.", - "operationId": "resolveRequestedEntitlements", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitlementsRequest" - } - } + "JsonApiWorkspaceOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/ApiEntitlement" - }, - "type": "array" - } + "included" : { + "description" : "Included resources", + "items" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceOutWithLinks" + }, + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "description": "OK" + "type" : "object" } }, - "summary": "Values for requested public entitlements.", - "tags": [ - "Entitlement", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "VIEW" - ] - } - } - }, - "/api/v1/actions/resolveSettings": { - "get": { - "description": "Resolves values for all settings without workspace by current user, organization, or default settings.", - "operationId": "resolveAllSettingsWithoutWorkspace", - "parameters": [ - { - "description": "If true, user-level settings are excluded from resolution.", - "in": "query", - "name": "excludeUserSettings", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/ResolvedSetting" + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiWorkspaceOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiWorkspaceOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiWorkspacePatch" : { + "description" : "JSON:API representation of patching workspace entity.", + "properties" : { + "attributes" : { + "properties" : { + "cacheExtraLimit" : { + "format" : "int64", + "type" : "integer" + }, + "dataSource" : { + "description" : "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", + "properties" : { + "id" : { + "description" : "The ID of the used data source.", + "example" : "snowflake.instance.1", + "type" : "string" }, - "type": "array" - } + "schemaPath" : { + "description" : "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", + "items" : { + "description" : "The part of the schema path.", + "example" : "subPath", + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "description" : { + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "earlyAccess" : { + "deprecated" : true, + "description" : "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "earlyAccessValues" : { + "description" : "The early access feature identifiers. They are used to enable experimental features.", + "items" : { + "maxLength" : 255, + "type" : "string" + }, + "nullable" : true, + "type" : "array" + }, + "name" : { + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "prefix" : { + "description" : "Custom prefix of entity identifiers in workspace", + "maxLength" : 255, + "nullable" : true, + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "relationships" : { + "properties" : { + "parent" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceToOneLinkage" + } + }, + "required" : [ "data" ], + "type" : "object" } }, - "description": "Values for selected settings." + "type" : "object" + }, + "type" : { + "description" : "Object type", + "enum" : [ "workspace" ], + "example" : "workspace", + "type" : "string" } }, - "summary": "Values for all settings without workspace.", - "tags": [ - "Reporting - Settings", - "actions" - ] + "required" : [ "id", "type" ], + "type" : "object" }, - "post": { - "description": "Resolves values for selected settings without workspace by current user, organization, or default settings.", - "operationId": "resolveSettingsWithoutWorkspace", - "parameters": [ - { - "description": "If true, user-level settings are excluded from resolution.", - "in": "query", - "name": "excludeUserSettings", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "JsonApiWorkspacePatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspacePatch" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ResolveSettingsRequest" - } - } - }, - "required": true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/ResolvedSetting" - }, - "type": "array" - } + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiWorkspaceSettingIn" : { + "description" : "JSON:API representation of workspaceSetting entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { }, + "type" : "object" + }, + "type" : { + "enum" : [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS" ], + "type" : "string" } }, - "description": "Values for selected settings." - } - }, - "summary": "Values for selected settings without workspace.", - "tags": [ - "Reporting - Settings", - "actions" - ] - } - }, - "/api/v1/actions/userManagement/assignPermissions": { - "post": { - "operationId": "assignPermissions", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PermissionsAssignment" - } - } + "type" : "object" }, - "required": true + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "workspaceSetting" ], + "example" : "workspaceSetting", + "type" : "string" + } }, - "responses": { - "200": { - "description": "OK" + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiWorkspaceSettingInDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingIn" } }, - "tags": [ - "User management" - ] - } - }, - "/api/v1/actions/userManagement/removeUsersUserGroups": { - "post": { - "operationId": "removeUsersUserGroups", - "requestBody": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/AssigneeIdentifier" - }, - "type": "array" + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiWorkspaceSettingOut" : { + "description" : "JSON:API representation of workspaceSetting entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { }, + "type" : "object" + }, + "type" : { + "enum" : [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS" ], + "type" : "string" } - } + }, + "type" : "object" }, - "required": true - }, - "responses": { - "200": { - "description": "OK" - } - }, - "tags": [ - "User management" - ] - } - }, - "/api/v1/actions/userManagement/revokePermissions": { - "post": { - "operationId": "revokePermissions", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PermissionsAssignment" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "meta" : { + "properties" : { + "origin" : { + "properties" : { + "originId" : { + "description" : "defines id of the workspace where the entity comes from", + "type" : "string" + }, + "originType" : { + "description" : "defines type of the origin of the entity", + "enum" : [ "NATIVE", "PARENT" ], + "type" : "string" + } + }, + "required" : [ "originId", "originType" ], + "type" : "object" } - } + }, + "type" : "object" }, - "required": true - }, - "responses": { - "200": { - "description": "OK" + "type" : { + "description" : "Object type", + "enum" : [ "workspaceSetting" ], + "example" : "workspaceSetting", + "type" : "string" } }, - "tags": [ - "User management" - ] - } - }, - "/api/v1/actions/userManagement/userGroups": { - "get": { - "operationId": "listUserGroups", - "parameters": [ - { - "description": "Zero-based page index (0..N)", - "example": "page=0", - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 0, - "format": "int32", - "type": "integer" - }, - "style": "form" - }, - { - "description": "The size of the page to be returned.", - "example": "size=20", - "in": "query", - "name": "size", - "required": false, - "schema": { - "default": 20, - "format": "int32", - "type": "integer" - }, - "style": "form" - }, - { - "description": "Filter by user name. Note that user name is case insensitive.", - "example": "name=charles", - "in": "query", - "name": "name", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "Filter by workspaceId.", - "example": "workspace=demo", - "in": "query", - "name": "workspace", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "Filter by dataSourceId.", - "example": "dataSource=demo-test-ds", - "in": "query", - "name": "dataSource", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserManagementUserGroups" - } - } - }, - "description": "OK" - } - }, - "tags": [ - "User management" - ] - } - }, - "/api/v1/actions/userManagement/userGroups/{userGroupId}/addMembers": { - "post": { - "operationId": "addGroupMembers", - "parameters": [ - { - "in": "path", - "name": "userGroupId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserManagementUserGroupMembers" - } - } + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiWorkspaceSettingOutDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingOut" }, - "required": true - }, - "responses": { - "204": { - "description": "No Content" + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "tags": [ - "User management" - ] - } - }, - "/api/v1/actions/userManagement/userGroups/{userGroupId}/members": { - "get": { - "operationId": "getGroupMembers", - "parameters": [ - { - "in": "path", - "name": "userGroupId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserManagementUserGroupMembers" - } - } + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiWorkspaceSettingOutList" : { + "description" : "A JSON:API document with a list of resources", + "properties" : { + "data" : { + "items" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingOutWithLinks" }, - "description": "OK" - } - }, - "tags": [ - "User management" - ] - } - }, - "/api/v1/actions/userManagement/userGroups/{userGroupId}/permissions": { - "get": { - "operationId": "listPermissionsForUserGroup", - "parameters": [ - { - "in": "path", - "name": "userGroupId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserManagementPermissionAssignments" - } + "type" : "array", + "uniqueItems" : true + }, + "links" : { + "$ref" : "#/components/schemas/ListLinks" + }, + "meta" : { + "properties" : { + "page" : { + "$ref" : "#/components/schemas/PageMetadata" } }, - "description": "OK" + "type" : "object" } }, - "tags": [ - "User management" - ] + "required" : [ "data" ], + "type" : "object" }, - "post": { - "operationId": "managePermissionsForUserGroup", - "parameters": [ - { - "in": "path", - "name": "userGroupId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserManagementPermissionAssignments" + "JsonApiWorkspaceSettingOutWithLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingOut" + }, { + "$ref" : "#/components/schemas/ObjectLinksContainer" + } ] + }, + "JsonApiWorkspaceSettingPatch" : { + "description" : "JSON:API representation of patching workspaceSetting entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { }, + "type" : "object" + }, + "type" : { + "enum" : [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS" ], + "type" : "string" } - } + }, + "type" : "object" }, - "required": true - }, - "responses": { - "204": { - "description": "No Content" + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "workspaceSetting" ], + "example" : "workspaceSetting", + "type" : "string" } }, - "tags": [ - "User management" - ] - } - }, - "/api/v1/actions/userManagement/userGroups/{userGroupId}/removeMembers": { - "post": { - "operationId": "removeGroupMembers", - "parameters": [ - { - "in": "path", - "name": "userGroupId", - "required": true, - "schema": { - "type": "string" - } + "required" : [ "id", "type" ], + "type" : "object" + }, + "JsonApiWorkspaceSettingPatchDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingPatch" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserManagementUserGroupMembers" - } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiWorkspaceSettingPostOptionalId" : { + "description" : "JSON:API representation of workspaceSetting entity.", + "properties" : { + "attributes" : { + "properties" : { + "content" : { + "description" : "Free-form JSON content. Maximum supported length is 15000 characters.", + "example" : { }, + "type" : "object" + }, + "type" : { + "enum" : [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS" ], + "type" : "string" + } + }, + "type" : "object" + }, + "id" : { + "description" : "API identifier of an object", + "example" : "id1", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "Object type", + "enum" : [ "workspaceSetting" ], + "example" : "workspaceSetting", + "type" : "string" + } + }, + "required" : [ "type" ], + "type" : "object" + }, + "JsonApiWorkspaceSettingPostOptionalIdDocument" : { + "properties" : { + "data" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingPostOptionalId" + } + }, + "required" : [ "data" ], + "type" : "object" + }, + "JsonApiWorkspaceToOneLinkage" : { + "description" : "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", + "nullable" : true, + "oneOf" : [ { + "$ref" : "#/components/schemas/JsonApiWorkspaceLinkage" + } ] + }, + "JsonNode" : { + "description" : "Free-form JSON object", + "example" : { }, + "maxLength" : 15000, + "nullable" : true, + "type" : "object" + }, + "LabelIdentifier" : { + "description" : "A label identifier.", + "properties" : { + "id" : { + "description" : "Label ID.", + "example" : "label_id", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "A type of the label.", + "enum" : [ "label" ], + "example" : "label", + "type" : "string" + } + }, + "required" : [ "id", "type" ], + "type" : "object" + }, + "ListLinks" : { + "allOf" : [ { + "$ref" : "#/components/schemas/ObjectLinks" + }, { + "properties" : { + "next" : { + "description" : "A string containing the link's URL for the next page of data.", + "format" : "uri", + "type" : "string" + } + }, + "type" : "object" + } ] + }, + "LocalIdentifier" : { + "properties" : { + "format" : { + "default" : "#,##0.00", + "description" : "Metric format.", + "example" : "#,##0", + "maxLength" : 2048, + "nullable" : true, + "type" : "string" + }, + "localIdentifier" : { + "description" : "Local identifier of the metric to be compared.", + "example" : "m1", + "type" : "string" + }, + "title" : { + "description" : "Metric title.", + "example" : "Revenue", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + } + }, + "required" : [ "localIdentifier" ], + "type" : "object" + }, + "LocaleRequest" : { + "properties" : { + "locale" : { + "description" : "Requested locale in the form of language tag (see RFC 5646).", + "example" : "en-US", + "type" : "string" + } + }, + "required" : [ "locale" ], + "type" : "object" + }, + "MeasureDefinition" : { + "description" : "Abstract metric definition type", + "oneOf" : [ { + "$ref" : "#/components/schemas/InlineMeasureDefinition" + }, { + "$ref" : "#/components/schemas/ArithmeticMeasureDefinition" + }, { + "$ref" : "#/components/schemas/SimpleMeasureDefinition" + }, { + "$ref" : "#/components/schemas/PopMeasureDefinition" + } ], + "type" : "object" + }, + "MeasureItem" : { + "description" : "Metric is a quantity that is calculated from the data.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/MeasureDefinition" + }, + "localIdentifier" : { + "description" : "Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.", + "example" : "metric_1", + "pattern" : "^[.a-zA-Z0-9_-]+$", + "type" : "string" + } + }, + "required" : [ "definition", "localIdentifier" ], + "type" : "object" + }, + "MeasureValueCondition" : { + "description" : "A condition for filtering by measure value. Can be either a comparison or a range condition.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ComparisonCondition" + }, { + "$ref" : "#/components/schemas/RangeCondition" + } ], + "type" : "object" + }, + "MeasureValueFilter" : { + "description" : "Abstract filter definition type filtering by the value of the metric.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ComparisonMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/RangeMeasureValueFilter" + }, { + "$ref" : "#/components/schemas/CompoundMeasureValueFilter" + } ], + "type" : "object" + }, + "NegativeAttributeFilter" : { + "description" : "Filter able to limit element values by label and related selected negated elements.", + "properties" : { + "negativeAttributeFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "label" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "localIdentifier" : { + "type" : "string" + }, + "notIn" : { + "$ref" : "#/components/schemas/AttributeFilterElements" + } + }, + "required" : [ "notIn", "label" ], + "type" : "object" + } + }, + "required" : [ "negativeAttributeFilter" ], + "type" : "object" + }, + "Note" : { + "properties" : { + "appliesTo" : { + "enum" : [ "SOURCE", "TARGET" ], + "type" : "string", + "xml" : { + "attribute" : true } }, - "required": true - }, - "responses": { - "204": { - "description": "No Content" - } - }, - "tags": [ - "User management" - ] - } - }, - "/api/v1/actions/userManagement/users": { - "get": { - "operationId": "listUsers", - "parameters": [ - { - "description": "Zero-based page index (0..N)", - "example": "page=0", - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 0, - "format": "int32", - "type": "integer" - }, - "style": "form" - }, - { - "description": "The size of the page to be returned.", - "example": "size=20", - "in": "query", - "name": "size", - "required": false, - "schema": { - "default": 20, - "format": "int32", - "type": "integer" - }, - "style": "form" - }, - { - "description": "Filter by user name. Note that user name is case insensitive.", - "example": "name=charles", - "in": "query", - "name": "name", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "Filter by workspaceId.", - "example": "workspace=demo", - "in": "query", - "name": "workspace", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "Filter by userGroupId.", - "example": "group=admin", - "in": "query", - "name": "group", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "Filter by dataSourceId.", - "example": "dataSource=demo-test-ds", - "in": "query", - "name": "dataSource", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserManagementUsers" - } - } - }, - "description": "OK" - } - }, - "tags": [ - "User management" - ] - } - }, - "/api/v1/actions/userManagement/users/{userId}/permissions": { - "get": { - "operationId": "listPermissionsForUser", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" + "category" : { + "type" : "string", + "xml" : { + "attribute" : true + } + }, + "content" : { + "type" : "string" + }, + "id" : { + "type" : "string", + "xml" : { + "attribute" : true + } + }, + "otherAttributes" : { + "additionalProperties" : { + "type" : "string" + }, + "type" : "object" + }, + "priority" : { + "format" : "int32", + "type" : "integer", + "xml" : { + "attribute" : true } } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserManagementPermissionAssignments" - } - } + }, + "type" : "object", + "xml" : { + "name" : "note", + "namespace" : "urn:oasis:names:tc:xliff:document:2.0" + } + }, + "Notes" : { + "properties" : { + "note" : { + "items" : { + "$ref" : "#/components/schemas/Note" }, - "description": "OK" + "type" : "array" } }, - "tags": [ - "User management" - ] + "required" : [ "note" ], + "type" : "object", + "xml" : { + "name" : "notes", + "namespace" : "urn:oasis:names:tc:xliff:document:2.0" + } }, - "post": { - "operationId": "managePermissionsForUser", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } + "NotificationChannelDestination" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/Webhook" + }, { + "$ref" : "#/components/schemas/Smtp" + }, { + "$ref" : "#/components/schemas/DefaultSmtp" + }, { + "$ref" : "#/components/schemas/InPlatform" + } ], + "properties" : { + "type" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserManagementPermissionAssignments" - } - } - }, - "required": true }, - "responses": { - "204": { - "description": "No Content" + "required" : [ "type" ], + "type" : "object" + }, + "ObjectLinks" : { + "properties" : { + "self" : { + "description" : "A string containing the link's URL.", + "format" : "uri", + "type" : "string" } }, - "tags": [ - "User management" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees": { - "get": { - "operationId": "availableAssignees", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "dashboardId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AvailableAssignees" - } - } - }, - "description": "OK" + "required" : [ "self" ], + "type" : "object" + }, + "ObjectLinksContainer" : { + "properties" : { + "links" : { + "$ref" : "#/components/schemas/ObjectLinks" } }, - "summary": "Get Available Assignees", - "tags": [ - "Permissions", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions": { - "post": { - "operationId": "manageDashboardPermissions", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "type" : "object" + }, + "OrganizationAutomationIdentifier" : { + "properties" : { + "id" : { + "type" : "string" }, - { - "in": "path", - "name": "dashboardId", - "required": true, - "schema": { - "type": "string" - } + "workspaceId" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "An array of dashboard permissions assignments", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/PermissionsForAssignee" - }, - { - "$ref": "#/components/schemas/PermissionsForAssigneeRule" - } - ] - }, - "type": "array" - } - } - }, - "required": true }, - "responses": { - "204": { - "description": "No Content" + "required" : [ "id", "workspaceId" ], + "type" : "object" + }, + "OrganizationAutomationManagementBulkRequest" : { + "properties" : { + "automations" : { + "items" : { + "$ref" : "#/components/schemas/OrganizationAutomationIdentifier" + }, + "type" : "array" } }, - "summary": "Manage Permissions for a Dashboard", - "tags": [ - "Permissions", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions": { - "get": { - "operationId": "dashboardPermissions", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "required" : [ "automations" ], + "type" : "object" + }, + "OrganizationPermissionAssignment" : { + "description" : "Organization permission assignments", + "properties" : { + "assigneeIdentifier" : { + "$ref" : "#/components/schemas/AssigneeIdentifier" }, - { - "in": "path", - "name": "dashboardId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DashboardPermissions" - } - } + "permissions" : { + "items" : { + "enum" : [ "MANAGE", "SELF_CREATE_TOKEN" ], + "type" : "string" }, - "description": "OK" - } - }, - "summary": "Get Dashboard Permissions", - "tags": [ - "Permissions", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/automations/delete": { - "post": { - "operationId": "deleteWorkspaceAutomations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "type" : "array" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" - } - } - }, - "required": true }, - "responses": { - "204": { - "description": "No Content" + "required" : [ "assigneeIdentifier", "permissions" ], + "type" : "object" + }, + "Over" : { + "properties" : { + "attributes" : { + "items" : { + "$ref" : "#/components/schemas/IdentifierRef" + }, + "type" : "array" } }, - "summary": "Delete selected automations in the workspace", - "tags": [ - "Automations", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/automations/pause": { - "post": { - "operationId": "pauseWorkspaceAutomations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" - } - } + "required" : [ "attributes" ], + "type" : "object" + }, + "PageMetadata" : { + "properties" : { + "number" : { + "description" : "The number of the current page", + "format" : "int32", + "type" : "integer" }, - "required": true - }, - "responses": { - "204": { - "description": "No Content" + "size" : { + "description" : "The size of the current page", + "format" : "int32", + "type" : "integer" + }, + "totalElements" : { + "description" : "The total number of elements", + "format" : "int32", + "type" : "integer" + }, + "totalPages" : { + "description" : "The total number of pages", + "format" : "int32", + "type" : "integer" } }, - "summary": "Pause selected automations in the workspace", - "tags": [ - "Automations", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/automations/unpause": { - "post": { - "operationId": "unpauseWorkspaceAutomations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" - } - } + "type" : "object" + }, + "Parameter" : { + "properties" : { + "name" : { + "type" : "string" }, - "required": true - }, - "responses": { - "204": { - "description": "No Content" + "value" : { + "type" : "string" } }, - "summary": "Unpause selected automations in the workspace", - "tags": [ - "Automations", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe": { - "delete": { - "operationId": "unsubscribeWorkspaceAutomations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "No Content" - } - }, - "summary": "Unsubscribe from all automations in the workspace", - "tags": [ - "Automations", - "actions" - ] - }, - "post": { - "operationId": "unsubscribeSelectedWorkspaceAutomations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" - } - } + "required" : [ "name", "value" ], + "type" : "object" + }, + "PdfTableStyle" : { + "deprecated" : true, + "description" : "Custom CSS styles for the table. (PDF, HTML)", + "example" : [ { + "properties" : [ { + "key" : "font-size", + "value" : "30px" + } ], + "selector" : "th" + } ], + "properties" : { + "properties" : { + "description" : "List of CSS properties.", + "items" : { + "$ref" : "#/components/schemas/PdfTableStyleProperty" + }, + "type" : "array" }, - "required": true - }, - "responses": { - "204": { - "description": "No Content" + "selector" : { + "description" : "CSS selector where to apply given properties.", + "type" : "string" } }, - "summary": "Unsubscribe from selected automations in the workspace", - "tags": [ - "Automations", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe": { - "delete": { - "operationId": "unsubscribeAutomation", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "required" : [ "selector" ], + "type" : "object" + }, + "PdfTableStyleProperty" : { + "description" : "CSS property.", + "properties" : { + "key" : { + "description" : "CSS property key.", + "type" : "string" }, - { - "in": "path", - "name": "automationId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "No Content" + "value" : { + "description" : "CSS property value.", + "type" : "string" } }, - "summary": "Unsubscribe from an automation", - "tags": [ - "Automations", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides": { - "post": { - "description": "Finds entities with given ID in hierarchy (e.g. to check possible future conflicts).", - "operationId": "checkEntityOverrides", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "An array of object identifications", - "items": { - "$ref": "#/components/schemas/HierarchyObjectIdentification" - }, - "type": "array" - } - } + "required" : [ "key", "value" ], + "type" : "object" + }, + "PdmLdmRequest" : { + "description" : "PDM additions wrapper.", + "properties" : { + "sqls" : { + "description" : "List of SQL datasets.", + "items" : { + "$ref" : "#/components/schemas/PdmSql" + }, + "type" : "array" }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/IdentifierDuplications" - }, - "type": "array" - } - } + "tableOverrides" : { + "description" : "(BETA) List of table overrides.", + "items" : { + "$ref" : "#/components/schemas/TableOverride" + }, + "type" : "array" + }, + "tables" : { + "description" : "List of physical database tables.", + "items" : { + "$ref" : "#/components/schemas/DeclarativeTable" }, - "description": "Searching for entities finished successfully." + "type" : "array" } }, - "summary": "Finds entities with given ID in hierarchy.", - "tags": [ - "Hierarchy", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "ANALYZE" - ] - } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph": { - "get": { - "description": "Computes the dependent entities graph", - "operationId": "getDependentEntitiesGraph", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DependentEntitiesResponse" - } - } + "type" : "object" + }, + "PdmSql" : { + "description" : "SQL dataset definition.", + "properties" : { + "columns" : { + "description" : "Columns defining SQL dataset.", + "items" : { + "$ref" : "#/components/schemas/SqlColumn" }, - "description": "Computes the dependent entities graph" + "type" : "array" + }, + "statement" : { + "description" : "SQL statement.", + "example" : "select * from abc", + "type" : "string" + }, + "title" : { + "description" : "SQL dataset title.", + "example" : "My special dataset", + "type" : "string" } }, - "summary": "Computes the dependent entities graph", - "tags": [ - "Dependency Graph", - "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to read the graph.", - "permissions": [ - "VIEW" - ] - } + "required" : [ "statement", "title" ], + "type" : "object" }, - "post": { - "description": "Computes the dependent entities graph from given entry points", - "operationId": "getDependentEntitiesGraphFromEntryPoints", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DependentEntitiesRequest" - } - } + "PermissionsAssignment" : { + "properties" : { + "assignees" : { + "items" : { + "$ref" : "#/components/schemas/AssigneeIdentifier" + }, + "type" : "array" }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DependentEntitiesResponse" - } - } + "dataSources" : { + "items" : { + "$ref" : "#/components/schemas/UserManagementDataSourcePermissionAssignment" }, - "description": "Computes the dependent entities graph from given entry points" - } - }, - "summary": "Computes the dependent entities graph from given entry points", - "tags": [ - "Dependency Graph", - "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to read the graph.", - "permissions": [ - "VIEW" - ] - } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts": { - "get": { - "description": "Finds API identifier conflicts in given workspace hierarchy.", - "operationId": "inheritedEntityConflicts", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/IdentifierDuplications" - }, - "type": "array" - } - } + "type" : "array" + }, + "workspaces" : { + "items" : { + "$ref" : "#/components/schemas/UserManagementWorkspacePermissionAssignment" }, - "description": "Searching for conflicting identifiers finished successfully" + "type" : "array" } }, - "summary": "Finds identifier conflicts in workspace hierarchy.", - "tags": [ - "Hierarchy", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/inheritedEntityPrefixes": { - "get": { - "description": "Get used entity prefixes in hierarchy of parent workspaces", - "operationId": "inheritedEntityPrefixes", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" + "required" : [ "assignees" ], + "type" : "object" + }, + "PermissionsForAssignee" : { + "allOf" : [ { + "$ref" : "#/components/schemas/DashboardPermissionsAssignment" + }, { + "properties" : { + "assigneeIdentifier" : { + "$ref" : "#/components/schemas/AssigneeIdentifier" + } + }, + "type" : "object" + } ], + "description" : "Desired levels of permissions for an assignee identified by an identifier.", + "required" : [ "assigneeIdentifier", "permissions" ], + "type" : "object" + }, + "PermissionsForAssigneeRule" : { + "allOf" : [ { + "$ref" : "#/components/schemas/DashboardPermissionsAssignment" + }, { + "properties" : { + "assigneeRule" : { + "$ref" : "#/components/schemas/AssigneeRule" } + }, + "type" : "object" + } ], + "description" : "Desired levels of permissions for a collection of assignees identified by a rule.", + "required" : [ "assigneeRule", "permissions" ], + "type" : "object" + }, + "PlatformUsage" : { + "properties" : { + "count" : { + "format" : "int32", + "type" : "integer" + }, + "name" : { + "enum" : [ "UserCount", "WorkspaceCount" ], + "type" : "string" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - } + }, + "required" : [ "name" ], + "type" : "object" + }, + "PlatformUsageRequest" : { + "properties" : { + "usageItemNames" : { + "items" : { + "enum" : [ "UserCount", "WorkspaceCount" ], + "type" : "string" }, - "description": "Prefixes used in parent entities" + "type" : "array", + "uniqueItems" : true } }, - "summary": "Get used entity prefixes in hierarchy", - "tags": [ - "Hierarchy", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "VIEW" - ] - } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/managePermissions": { - "post": { - "description": "Manage Permissions for a Workspace and its Workspace Hierarchy", - "operationId": "manageWorkspacePermissions", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "required" : [ "usageItemNames" ], + "type" : "object" + }, + "PopDataset" : { + "description" : "Combination of the date data set to use and how many periods ago to calculate the previous period for.", + "properties" : { + "dataset" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierDataset" + }, + "periodsAgo" : { + "description" : "Number of periods ago to calculate the previous period for.", + "example" : 1, + "format" : "int32", + "type" : "integer" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "An array of workspace permissions assignments", - "items": { - "$ref": "#/components/schemas/WorkspacePermissionAssignment" + }, + "required" : [ "dataset", "periodsAgo" ], + "type" : "object" + }, + "PopDatasetMeasureDefinition" : { + "description" : "Previous period type of metric.", + "properties" : { + "previousPeriodMeasure" : { + "properties" : { + "dateDatasets" : { + "description" : "Specification of which date data sets to use for determining the period to calculate the previous period for.", + "items" : { + "$ref" : "#/components/schemas/PopDataset" }, - "type": "array" + "type" : "array" + }, + "measureIdentifier" : { + "$ref" : "#/components/schemas/AfmLocalIdentifier" } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "No Content" + }, + "required" : [ "dateDatasets", "measureIdentifier" ], + "type" : "object" } }, - "summary": "Manage Permissions for a Workspace", - "tags": [ - "Permissions", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/metadataSync": { - "post": { - "description": "(BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only.", - "operationId": "metadataSync", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK" + "required" : [ "previousPeriodMeasure" ], + "type" : "object" + }, + "PopDate" : { + "description" : "Combination of the date attribute to use and how many periods ago to calculate the PoP for.", + "properties" : { + "attribute" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierAttribute" + }, + "periodsAgo" : { + "description" : "Number of periods ago to calculate the previous period for.", + "example" : 1, + "format" : "int32", + "type" : "integer" } }, - "summary": "(BETA) Sync Metadata to other services", - "tags": [ - "AI", - "Metadata Sync", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities": { - "get": { - "description": "Finds API identifier overrides in given workspace hierarchy.", - "operationId": "overriddenChildEntities", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/IdentifierDuplications" - }, - "type": "array" - } + "required" : [ "attribute", "periodsAgo" ], + "type" : "object" + }, + "PopDateMeasureDefinition" : { + "description" : "Period over period type of metric.", + "properties" : { + "overPeriodMeasure" : { + "properties" : { + "dateAttributes" : { + "description" : "Attributes to use for determining the period to calculate the PoP for.", + "items" : { + "$ref" : "#/components/schemas/PopDate" + }, + "type" : "array" + }, + "measureIdentifier" : { + "$ref" : "#/components/schemas/AfmLocalIdentifier" } }, - "description": "Searching for overridden identifiers finished successfully" + "required" : [ "dateAttributes", "measureIdentifier" ], + "type" : "object" } }, - "summary": "Finds identifier overrides in workspace hierarchy.", - "tags": [ - "Hierarchy", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/resolveSettings": { - "get": { - "description": "Resolves values for all settings in a workspace by current user, workspace, organization, or default settings.", - "operationId": "workspaceResolveAllSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "If true, user-level settings are excluded from resolution.", - "in": "query", - "name": "excludeUserSettings", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/ResolvedSetting" - }, - "type": "array" - } + "required" : [ "overPeriodMeasure" ], + "type" : "object" + }, + "PopMeasureDefinition" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/PopDatasetMeasureDefinition" + }, { + "$ref" : "#/components/schemas/PopDateMeasureDefinition" + } ], + "type" : "object" + }, + "PositiveAttributeFilter" : { + "description" : "Filter able to limit element values by label and related selected elements.", + "properties" : { + "positiveAttributeFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "in" : { + "$ref" : "#/components/schemas/AttributeFilterElements" + }, + "label" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "localIdentifier" : { + "type" : "string" } }, - "description": "Values for selected settings." + "required" : [ "in", "label" ], + "type" : "object" } }, - "summary": "Values for all settings.", - "tags": [ - "Workspaces - Settings", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "VIEW" - ] - } + "required" : [ "positiveAttributeFilter" ], + "type" : "object" }, - "post": { - "description": "Resolves value for selected settings in a workspace by current user, workspace, organization, or default settings.", - "operationId": "workspaceResolveSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "Range" : { + "properties" : { + "from" : { + "$ref" : "#/components/schemas/Value" }, - { - "description": "If true, user-level settings are excluded from resolution.", - "in": "query", - "name": "excludeUserSettings", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ResolveSettingsRequest" - } - } + "measure" : { + "$ref" : "#/components/schemas/LocalIdentifier" }, - "required": true + "operator" : { + "enum" : [ "BETWEEN", "NOT_BETWEEN" ], + "type" : "string" + }, + "to" : { + "$ref" : "#/components/schemas/Value" + } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/ResolvedSetting" - }, - "type": "array" - } + "required" : [ "from", "measure", "operator", "to" ], + "type" : "object" + }, + "RangeCondition" : { + "description" : "Condition that checks if the metric value is within a given range.", + "properties" : { + "range" : { + "properties" : { + "from" : { + "example" : 100, + "type" : "number" + }, + "operator" : { + "enum" : [ "BETWEEN", "NOT_BETWEEN" ], + "example" : "BETWEEN", + "type" : "string" + }, + "to" : { + "example" : 999, + "type" : "number" } }, - "description": "Values for selected settings." + "required" : [ "from", "operator", "to" ], + "type" : "object" } }, - "summary": "Values for selected settings.", - "tags": [ - "Workspaces - Settings", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "VIEW" - ] - } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/translations": { - "get": { - "description": "Provides a list of effective translation tags.", - "operationId": "getTranslationTags", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } + "required" : [ "range" ], + "type" : "object" + }, + "RangeMeasureValueFilter" : { + "description" : "Filter the result by comparing specified metric to given range of values.", + "properties" : { + "rangeMeasureValueFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "dimensionality" : { + "description" : "References to the attributes to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "type" : "array" + }, + "from" : { + "example" : 100, + "type" : "number" + }, + "localIdentifier" : { + "type" : "string" + }, + "measure" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "operator" : { + "enum" : [ "BETWEEN", "NOT_BETWEEN" ], + "example" : "BETWEEN", + "type" : "string" + }, + "to" : { + "example" : 999, + "type" : "number" + }, + "treatNullValuesAs" : { + "description" : "A value that will be substituted for null values in the metric for the comparisons.", + "example" : 0, + "type" : "number" } }, - "description": "Retrieved list of translation tags." + "required" : [ "from", "operator", "to", "measure" ], + "type" : "object" } }, - "summary": "Get translation tags.", - "tags": [ - "Translations", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/translations/clean": { - "post": { - "description": "Cleans up all translations for a particular locale.", - "operationId": "cleanTranslations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "required" : [ "rangeMeasureValueFilter" ], + "type" : "object" + }, + "RangeWrapper" : { + "properties" : { + "range" : { + "$ref" : "#/components/schemas/Range" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LocaleRequest" + }, + "required" : [ "range" ], + "type" : "object" + }, + "RankingFilter" : { + "description" : "Filter the result on top/bottom N values according to given metric(s).", + "properties" : { + "rankingFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" + }, + "dimensionality" : { + "description" : "References to the attributes to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "type" : "array" + }, + "localIdentifier" : { + "type" : "string" + }, + "measures" : { + "description" : "References to the metrics to be used when filtering.", + "items" : { + "$ref" : "#/components/schemas/AfmIdentifier" + }, + "type" : "array" + }, + "operator" : { + "description" : "The type of ranking to use, TOP or BOTTOM.", + "enum" : [ "TOP", "BOTTOM" ], + "type" : "string" + }, + "value" : { + "description" : "Number of top/bottom values to filter.", + "example" : 5, + "format" : "int32", + "type" : "integer" } - } - }, - "required": true + }, + "required" : [ "measures", "operator", "value" ], + "type" : "object" + } }, - "responses": { - "204": { - "description": "Translations were successfully removed." + "required" : [ "rankingFilter" ], + "type" : "object" + }, + "RawCustomLabel" : { + "description" : "Custom label object override.", + "properties" : { + "title" : { + "description" : "Override value.", + "type" : "string" } }, - "summary": "Cleans up translations.", - "tags": [ - "Translations", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/translations/retrieve": { - "post": { - "description": "Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value.", - "operationId": "retrieveTranslations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "required" : [ "title" ], + "type" : "object" + }, + "RawCustomMetric" : { + "description" : "Custom metric object override.", + "properties" : { + "title" : { + "description" : "Metric title override.", + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LocaleRequest" - } - } - }, - "required": true }, - "responses": { - "200": { - "content": { - "application/xml": { - "schema": { - "$ref": "#/components/schemas/Xliff" - } - } + "required" : [ "title" ], + "type" : "object" + }, + "RawCustomOverride" : { + "description" : "Custom cell value overrides (IDs will be replaced with specified values).", + "properties" : { + "labels" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/RawCustomLabel" + }, + "description" : "Map of CustomLabels with keys used as placeholders in export result.", + "type" : "object" + }, + "metrics" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/RawCustomMetric" }, - "description": "XLIFF file containing translations for a particular locale." + "description" : "Map of CustomMetrics with keys used as placeholders in export result.", + "type" : "object" } }, - "summary": "Retrieve translations for entities.", - "tags": [ - "Translations", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/translations/set": { - "post": { - "description": "Set translation for existing entities in a particular locale.", - "operationId": "setTranslations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/xml": { - "schema": { - "$ref": "#/components/schemas/Xliff" - } - } + "type" : "object" + }, + "RawExportAutomationRequest" : { + "description" : "Export request object describing the export properties and overrides for raw exports.", + "properties" : { + "customOverride" : { + "$ref" : "#/components/schemas/RawCustomOverride" + }, + "delimiter" : { + "description" : "Set column delimiter. (CSV)", + "maxLength" : 1, + "minLength" : 1, + "pattern" : "^[^\\r\\n\"]$", + "type" : "string" }, - "required": true + "execution" : { + "$ref" : "#/components/schemas/AFM" + }, + "executionSettings" : { + "$ref" : "#/components/schemas/ExecutionSettings" + }, + "fileName" : { + "description" : "Filename of downloaded file without extension.", + "example" : "result", + "type" : "string" + }, + "format" : { + "description" : "Requested resulting file type.", + "enum" : [ "ARROW_FILE", "ARROW_STREAM", "CSV" ], + "example" : "CSV", + "type" : "string" + }, + "metadata" : { + "$ref" : "#/components/schemas/JsonNode" + } }, - "responses": { - "204": { - "description": "Translations were successfully set." + "required" : [ "execution", "fileName", "format" ], + "type" : "object" + }, + "ReferenceIdentifier" : { + "description" : "A reference identifier.", + "properties" : { + "id" : { + "description" : "Reference ID.", + "example" : "customers", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "A type of the reference.", + "enum" : [ "dataset" ], + "example" : "DATASET", + "type" : "string" } }, - "summary": "Set translations for entities.", - "tags": [ - "Translations", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/userGroups": { - "get": { - "operationId": "listWorkspaceUserGroups", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "required" : [ "id", "type" ], + "type" : "object" + }, + "ReferenceSourceColumn" : { + "properties" : { + "column" : { + "type" : "string" }, - { - "description": "Zero-based page index (0..N)", - "example": "page=0", - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 0, - "format": "int32", - "type": "integer" - }, - "style": "form" - }, - { - "description": "The size of the page to be returned.", - "example": "size=20", - "in": "query", - "name": "size", - "required": false, - "schema": { - "default": 20, - "format": "int32", - "type": "integer" - }, - "style": "form" - }, - { - "description": "Filter by user name. Note that user name is case insensitive.", - "example": "name=charles", - "in": "query", - "name": "name", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkspaceUserGroups" - } - } - }, - "description": "OK" - } - }, - "tags": [ - "User management", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/users": { - "get": { - "operationId": "listWorkspaceUsers", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "dataType" : { + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "type" : "string" }, - { - "description": "Zero-based page index (0..N)", - "example": "page=0", - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 0, - "format": "int32", - "type": "integer" - }, - "style": "form" - }, - { - "description": "The size of the page to be returned.", - "example": "size=20", - "in": "query", - "name": "size", - "required": false, - "schema": { - "default": 20, - "format": "int32", - "type": "integer" - }, - "style": "form" - }, - { - "description": "Filter by user name. Note that user name is case insensitive.", - "example": "name=charles", - "in": "query", - "name": "name", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkspaceUsers" - } - } - }, - "description": "OK" - } - }, - "tags": [ - "User management", - "actions" - ] - } - }, - "/api/v1/entities/admin/cookieSecurityConfigurations/{id}": { - "get": { - "operationId": "getEntity@CookieSecurityConfigurations", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "lastRotation==InstantValue;rotationInterval==DurationValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" - } - } - }, - "description": "Request successfully processed" + "isNullable" : { + "type" : "boolean" + }, + "nullValue" : { + "type" : "string" + }, + "target" : { + "$ref" : "#/components/schemas/DatasetGrain" } }, - "summary": "Get CookieSecurityConfiguration", - "tags": [ - "Cookie Security Configuration", - "entities", - "organization-controller" - ] + "required" : [ "column", "target" ], + "type" : "object" }, - "patch": { - "operationId": "patchEntity@CookieSecurityConfigurations", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" + "Relative" : { + "properties" : { + "measure" : { + "$ref" : "#/components/schemas/ArithmeticMeasure" }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "lastRotation==InstantValue;rotationInterval==DurationValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "operator" : { + "description" : "Relative condition operator.\nINCREASES_BY - the metric increases by the specified value.\nDECREASES_BY - the metric decreases by the specified value.\nCHANGES_BY - the metric increases or decreases by the specified value.\n", + "enum" : [ "INCREASES_BY", "DECREASES_BY", "CHANGES_BY" ], + "type" : "string" + }, + "threshold" : { + "$ref" : "#/components/schemas/Value" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatchDocument" - } - } + }, + "required" : [ "measure", "operator", "threshold" ], + "type" : "object" + }, + "RelativeBoundedDateFilter" : { + "properties" : { + "from" : { + "format" : "int32", + "type" : "integer" }, - "required": true + "granularity" : { + "enum" : [ "ALL_TIME_GRANULARITY", "GDC.time.year", "GDC.time.week_us", "GDC.time.week_in_year", "GDC.time.week_in_quarter", "GDC.time.week", "GDC.time.euweek_in_year", "GDC.time.euweek_in_quarter", "GDC.time.quarter", "GDC.time.quarter_in_year", "GDC.time.month", "GDC.time.month_in_quarter", "GDC.time.month_in_year", "GDC.time.day_in_year", "GDC.time.day_in_quarter", "GDC.time.day_in_month", "GDC.time.day_in_week", "GDC.time.day_in_euweek", "GDC.time.date", "GDC.time.hour", "GDC.time.hour_in_day", "GDC.time.minute", "GDC.time.minute_in_hour", "GDC.time.fiscal_month", "GDC.time.fiscal_quarter", "GDC.time.fiscal_year" ], + "type" : "string" + }, + "to" : { + "format" : "int32", + "type" : "integer" + } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" - } + "required" : [ "granularity" ], + "type" : "object" + }, + "RelativeDateFilter" : { + "description" : "A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both.", + "properties" : { + "relativeDateFilter" : { + "properties" : { + "applyOnResult" : { + "type" : "boolean" }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" - } + "boundedFilter" : { + "$ref" : "#/components/schemas/BoundedFilter" + }, + "dataset" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierDataset" + }, + "from" : { + "description" : "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago').", + "example" : -6, + "format" : "int32", + "type" : "integer" + }, + "granularity" : { + "description" : "Date granularity specifying particular date attribute in given dimension.", + "enum" : [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], + "example" : "DAY", + "type" : "string" + }, + "localIdentifier" : { + "type" : "string" + }, + "to" : { + "description" : "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...).", + "example" : 0, + "format" : "int32", + "type" : "integer" } }, - "description": "Request successfully processed" + "required" : [ "from", "granularity", "to", "dataset" ], + "type" : "object" } }, - "summary": "Patch CookieSecurityConfiguration", - "tags": [ - "Cookie Security Configuration", - "entities", - "organization-controller" - ] + "required" : [ "relativeDateFilter" ], + "type" : "object" }, - "put": { - "operationId": "updateEntity@CookieSecurityConfigurations", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "lastRotation==InstantValue;rotationInterval==DurationValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "RelativeWrapper" : { + "properties" : { + "relative" : { + "$ref" : "#/components/schemas/Relative" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationInDocument" - } + }, + "required" : [ "relative" ], + "type" : "object" + }, + "ResolveSettingsRequest" : { + "description" : "A request containing setting IDs to resolve.", + "properties" : { + "settings" : { + "description" : "An array of setting IDs to resolve.", + "example" : [ "timezone" ], + "items" : { + "type" : "string" }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationInDocument" - } - } + "type" : "array" + } + }, + "required" : [ "settings" ], + "type" : "object" + }, + "ResolvedSetting" : { + "description" : "Setting and its value.", + "properties" : { + "content" : { + "$ref" : "#/components/schemas/JsonNode" }, - "required": true + "id" : { + "deprecated" : true, + "description" : "Setting ID. Formerly used to identify a type of a particular setting, going to be removed in a favor of setting's type.", + "type" : "string" + }, + "type" : { + "description" : "Type of the setting.", + "enum" : [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_ENDPOINT", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "ENABLE_NULL_JOINS", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS" ], + "example" : "TIMEZONE", + "type" : "string" + } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" - } - } + "required" : [ "id" ], + "type" : "object" + }, + "RsaSpecification" : { + "properties" : { + "alg" : { + "enum" : [ "RS256", "RS384", "RS512" ], + "type" : "string" + }, + "e" : { + "type" : "string" + }, + "kid" : { + "maxLength" : 255, + "minLength" : 0, + "pattern" : "^[^.]", + "type" : "string" + }, + "kty" : { + "enum" : [ "RSA" ], + "type" : "string" + }, + "n" : { + "type" : "string" + }, + "use" : { + "enum" : [ "sig" ], + "type" : "string" + }, + "x5c" : { + "items" : { + "type" : "string" }, - "description": "Request successfully processed" + "type" : "array" + }, + "x5t" : { + "type" : "string" } }, - "summary": "Put CookieSecurityConfiguration", - "tags": [ - "Cookie Security Configuration", - "entities", - "organization-controller" - ] - } - }, - "/api/v1/entities/admin/organizations/{id}": { - "get": { - "operationId": "getEntity@Organizations", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "bootstrapUser,bootstrapUserGroup,identityProvider", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "users", - "userGroups", - "identityProviders", - "bootstrapUser", - "bootstrapUserGroup", - "identityProvider", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get Organizations", - "tags": [ - "Organization - Entity APIs", - "entities", - "organization-controller" - ], - "x-gdc-security-info": { - "description": "Contains permissions required to manipulate the Organization.", - "permissions": [ - "MANAGE" - ] + "required" : [ "alg", "e", "kid", "kty", "n", "use" ], + "type" : "object" + }, + "RulePermission" : { + "description" : "List of rules", + "properties" : { + "permissions" : { + "description" : "Permissions granted by the rule", + "items" : { + "$ref" : "#/components/schemas/GrantedPermission" + }, + "type" : "array" + }, + "type" : { + "description" : "Type of the rule", + "example" : "allWorkspaceUsers", + "type" : "string" + } + }, + "required" : [ "type" ], + "type" : "object" + }, + "RunningSection" : { + "description" : "Footer section of the slide", + "nullable" : true, + "properties" : { + "left" : { + "description" : "Either {{logo}} variable or custom text with combination of other variables.", + "nullable" : true, + "type" : "string" + }, + "right" : { + "description" : "Either {{logo}} variable or custom text with combination of other variables.", + "nullable" : true, + "type" : "string" + } + }, + "type" : "object" + }, + "SectionSlideTemplate" : { + "description" : "Settings for section slide.", + "nullable" : true, + "properties" : { + "backgroundImage" : { + "default" : true, + "description" : "Show background image on the slide.", + "type" : "boolean" + }, + "footer" : { + "$ref" : "#/components/schemas/RunningSection" + }, + "header" : { + "$ref" : "#/components/schemas/RunningSection" + } + }, + "type" : "object" + }, + "Settings" : { + "description" : "Additional settings.", + "properties" : { + "delimiter" : { + "description" : "Set column delimiter. (CSV)", + "maxLength" : 1, + "minLength" : 1, + "pattern" : "^[^\\r\\n\"]$", + "type" : "string" + }, + "exportInfo" : { + "default" : false, + "description" : "If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF)", + "example" : true, + "type" : "boolean" + }, + "mergeHeaders" : { + "description" : "Merge equal headers in neighbouring cells. (XLSX)", + "example" : true, + "type" : "boolean" + }, + "pageOrientation" : { + "default" : "PORTRAIT", + "description" : "Set page orientation. (PDF)", + "enum" : [ "PORTRAIT", "LANDSCAPE" ], + "type" : "string" + }, + "pageSize" : { + "default" : "A4", + "description" : "Set page size. (PDF)", + "enum" : [ "A3", "A4", "LETTER" ], + "type" : "string" + }, + "pdfPageSize" : { + "deprecated" : true, + "description" : "Page size and orientation. (PDF)", + "example" : "a4 landscape", + "type" : "string" + }, + "pdfTableStyle" : { + "deprecated" : true, + "description" : "Custom CSS styles for the table. (PDF, HTML)", + "example" : [ { + "properties" : [ { + "key" : "font-size", + "value" : "30px" + } ], + "selector" : "th" + } ], + "items" : { + "$ref" : "#/components/schemas/PdfTableStyle" + }, + "type" : "array" + }, + "pdfTopLeftContent" : { + "deprecated" : true, + "description" : "Top left header content. (PDF)", + "example" : "Good", + "type" : "string" + }, + "pdfTopRightContent" : { + "deprecated" : true, + "description" : "Top right header content. (PDF)", + "example" : "Morning", + "type" : "string" + }, + "showFilters" : { + "deprecated" : true, + "description" : "Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)", + "example" : false, + "type" : "boolean" + } + }, + "type" : "object" + }, + "SimpleMeasureDefinition" : { + "description" : "Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.", + "properties" : { + "measure" : { + "properties" : { + "aggregation" : { + "description" : "Definition of aggregation type of the metric.", + "enum" : [ "SUM", "COUNT", "AVG", "MIN", "MAX", "MEDIAN", "RUNSUM", "APPROXIMATE_COUNT" ], + "example" : "SUM", + "type" : "string" + }, + "computeRatio" : { + "default" : false, + "description" : "If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).", + "example" : true, + "type" : "boolean" + }, + "filters" : { + "description" : "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.", + "items" : { + "$ref" : "#/components/schemas/FilterDefinitionForSimpleMeasure" + }, + "type" : "array" + }, + "item" : { + "$ref" : "#/components/schemas/AfmObjectIdentifierCore" + } + }, + "required" : [ "item" ], + "type" : "object" + } + }, + "required" : [ "measure" ], + "type" : "object" + }, + "Skeleton" : { + "properties" : { + "content" : { + "items" : { + "type" : "object" + }, + "type" : "array" + }, + "href" : { + "type" : "string", + "xml" : { + "attribute" : true + } + } + }, + "type" : "object", + "xml" : { + "name" : "skeleton", + "namespace" : "urn:oasis:names:tc:xliff:document:2.0" } }, - "patch": { - "operationId": "patchEntity@Organizations", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "SlidesExportRequest" : { + "description" : "Export request object describing the export properties and metadata for slides exports.", + "properties" : { + "dashboardId" : { + "description" : "Dashboard identifier", + "example" : "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type" : "string" + }, + "fileName" : { + "description" : "File name to be used for retrieving the pdf document.", + "example" : "filename", + "type" : "string" + }, + "format" : { + "description" : "Requested resulting file type.", + "enum" : [ "PDF", "PPTX" ], + "example" : "PDF", + "type" : "string" + }, + "metadata" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "templateId" : { + "description" : "Export template identifier.", + "maxLength" : 255, + "nullable" : true, + "type" : "string" + }, + "visualizationIds" : { + "description" : "List of visualization ids to be exported. Note that only one visualization is currently supported.", + "items" : { + "maxLength" : 255, + "minLength" : 1, + "type" : "string" + }, + "maxItems" : 1, + "type" : "array", + "uniqueItems" : true + }, + "widgetIds" : { + "description" : "List of widget identifiers to be exported. Note that only one widget is currently supported.", + "items" : { + "maxLength" : 255, + "minLength" : 1, + "type" : "string" + }, + "maxItems" : 1, + "type" : "array", + "uniqueItems" : true + } + }, + "required" : [ "fileName", "format" ], + "type" : "object" + }, + "Smtp" : { + "allOf" : [ { + "properties" : { + "fromEmail" : { + "default" : "no-reply@gooddata.com", + "description" : "E-mail address to send notifications from.", + "format" : "email", + "type" : "string" + }, + "fromEmailName" : { + "default" : "GoodData", + "description" : "An optional e-mail name to send notifications from.", + "type" : "string" + }, + "host" : { + "description" : "The SMTP server address.", + "type" : "string" + }, + "password" : { + "description" : "The SMTP server password.", + "type" : "string", + "writeOnly" : true + }, + "port" : { + "description" : "The SMTP server port.", + "enum" : [ 25, 465, 587, 2525 ], + "format" : "int32", + "type" : "integer" + }, + "type" : { + "description" : "The destination type.", + "enum" : [ "SMTP" ], + "type" : "string" + }, + "username" : { + "description" : "The SMTP server username.", + "type" : "string" + } + }, + "type" : "object" + } ], + "description" : "Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update", + "required" : [ "type" ], + "type" : "object" + }, + "SqlColumn" : { + "description" : "Columns defining SQL dataset.", + "properties" : { + "dataType" : { + "description" : "Column data type.", + "enum" : [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], + "example" : "STRING", + "type" : "string" + }, + "name" : { + "description" : "Column name.", + "example" : "ABC", + "type" : "string" + } + }, + "required" : [ "dataType", "name" ], + "type" : "object" + }, + "SwitchIdentityProviderRequest" : { + "properties" : { + "idpId" : { + "description" : "Identity provider ID to set as active for the organization.", + "example" : "my-idp-123", + "type" : "string" + } + }, + "required" : [ "idpId" ], + "type" : "object" + }, + "TableOverride" : { + "description" : "Table override settings.", + "properties" : { + "columns" : { + "description" : "An array of column overrides", + "items" : { + "$ref" : "#/components/schemas/ColumnOverride" + }, + "type" : "array" + }, + "path" : { + "description" : "Path for the table.", + "example" : [ "schema", "table_name" ], + "items" : { + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ "columns", "path" ], + "type" : "object" + }, + "TabularExportRequest" : { + "description" : "Export request object describing the export properties and overrides for tabular exports.", + "properties" : { + "customOverride" : { + "$ref" : "#/components/schemas/CustomOverride" + }, + "executionResult" : { + "description" : "Execution result identifier.", + "example" : "ff483727196c9dc862c7fd3a5a84df55c96d61a4", + "type" : "string" + }, + "fileName" : { + "description" : "Filename of downloaded file without extension.", + "example" : "result", + "type" : "string" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "bootstrapUser,bootstrapUserGroup,identityProvider", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "users", - "userGroups", - "identityProviders", - "bootstrapUser", - "bootstrapUserGroup", - "identityProvider", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationPatchDocument" - } - } + "format" : { + "description" : "Expected file format.", + "enum" : [ "CSV", "XLSX", "HTML", "PDF" ], + "example" : "CSV", + "type" : "string" }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" - } - } + "metadata" : { + "$ref" : "#/components/schemas/JsonNode" + }, + "relatedDashboardId" : { + "description" : "Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.", + "example" : "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type" : "string" + }, + "settings" : { + "$ref" : "#/components/schemas/Settings" + }, + "visualizationObject" : { + "description" : "Visualization object identifier. Alternative to executionResult property.", + "example" : "f7c359bc-c230-4487-b15b-ad9685bcb537", + "type" : "string" + }, + "visualizationObjectCustomFilters" : { + "description" : "Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.", + "example" : "[{\"negativeAttributeFilter\":{\"displayForm\":{\"identifier\":{\"id\":\"products.category\",\"type\":\"label\"}},\"notIn\":{\"values\":[\"Books\"]}}}]", + "items" : { + "type" : "object" }, - "description": "Request successfully processed" + "type" : "array" } }, - "summary": "Patch Organization", - "tags": [ - "Organization - Entity APIs", - "entities", - "organization-controller" - ], - "x-gdc-security-info": { - "description": "Contains permissions required to manipulate the Organization.", - "permissions": [ - "MANAGE" - ] - } + "required" : [ "fileName", "format" ], + "type" : "object" }, - "put": { - "operationId": "updateEntity@Organizations", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "UserAssignee" : { + "description" : "List of users", + "properties" : { + "email" : { + "description" : "User email address", + "example" : "user@example.com", + "type" : "string" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "bootstrapUser,bootstrapUserGroup,identityProvider", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "users", - "userGroups", - "identityProviders", - "bootstrapUser", - "bootstrapUserGroup", - "identityProvider", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationInDocument" - } - } + "id" : { + "type" : "string" }, - "required": true + "name" : { + "description" : "User name", + "example" : "John Wick", + "type" : "string" + } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" - } - } - }, - "description": "Request successfully processed" + "required" : [ "id" ], + "type" : "object" + }, + "UserGroupAssignee" : { + "description" : "List of user groups", + "properties" : { + "id" : { + "type" : "string" + }, + "name" : { + "description" : "User group name", + "example" : "admins", + "type" : "string" } }, - "summary": "Put Organization", - "tags": [ - "Organization - Entity APIs", - "entities", - "organization-controller" - ], - "x-gdc-security-info": { - "description": "Contains permissions required to manipulate the Organization.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/entities/colorPalettes": { - "get": { - "operationId": "getAllEntities@ColorPalettes", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;content==JsonNodeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "required" : [ "id" ], + "type" : "object" + }, + "UserGroupIdentifier" : { + "description" : "A list of groups where user is a member", + "properties" : { + "id" : { + "type" : "string" }, - { - "$ref": "#/components/parameters/page" + "name" : { + "type" : "string" + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "UserGroupPermission" : { + "description" : "List of user groups", + "properties" : { + "id" : { + "type" : "string" }, - { - "$ref": "#/components/parameters/size" + "name" : { + "description" : "Name of the user group", + "example" : "admins", + "type" : "string" }, - { - "$ref": "#/components/parameters/sort" + "permissions" : { + "description" : "Permissions granted to the user group", + "items" : { + "$ref" : "#/components/schemas/GrantedPermission" + }, + "type" : "array" + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "UserManagementDataSourcePermissionAssignment" : { + "description" : "Datasource permission assignments for users and userGroups", + "properties" : { + "id" : { + "description" : "Id of the datasource", + "type" : "string" }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true + "name" : { + "description" : "Name of the datasource", + "readOnly" : true, + "type" : "string" + }, + "permissions" : { + "items" : { + "enum" : [ "MANAGE", "USE" ], + "type" : "string" }, - "style": "form" + "type" : "array" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutList" - } - } + }, + "required" : [ "id", "permissions" ], + "type" : "object" + }, + "UserManagementPermissionAssignments" : { + "properties" : { + "dataSources" : { + "items" : { + "$ref" : "#/components/schemas/UserManagementDataSourcePermissionAssignment" + }, + "type" : "array" + }, + "workspaces" : { + "items" : { + "$ref" : "#/components/schemas/UserManagementWorkspacePermissionAssignment" }, - "description": "Request successfully processed" + "type" : "array" } }, - "summary": "Get all Color Pallettes", - "tags": [ - "Appearance", - "entities", - "organization-model-controller" - ] + "required" : [ "dataSources", "workspaces" ], + "type" : "object" }, - "post": { - "operationId": "createEntity@ColorPalettes", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" - } + "UserManagementUserGroupMember" : { + "properties" : { + "id" : { + "type" : "string" + }, + "name" : { + "readOnly" : true, + "type" : "string" + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "UserManagementUserGroupMembers" : { + "properties" : { + "members" : { + "items" : { + "$ref" : "#/components/schemas/UserManagementUserGroupMember" }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" - } - } + "type" : "array" + } + }, + "required" : [ "members" ], + "type" : "object" + }, + "UserManagementUserGroups" : { + "properties" : { + "totalCount" : { + "description" : "Total number of groups", + "format" : "int32", + "type" : "integer" }, - "required": true + "userGroups" : { + "items" : { + "$ref" : "#/components/schemas/UserManagementUserGroupsItem" + }, + "type" : "array" + } }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" - } - } + "required" : [ "totalCount", "userGroups" ], + "type" : "object" + }, + "UserManagementUserGroupsItem" : { + "description" : "List of groups", + "properties" : { + "dataSources" : { + "items" : { + "$ref" : "#/components/schemas/UserManagementDataSourcePermissionAssignment" + }, + "type" : "array" + }, + "id" : { + "type" : "string" + }, + "name" : { + "description" : "Group name", + "example" : "admins", + "type" : "string" + }, + "organizationAdmin" : { + "description" : "Is group organization admin", + "example" : false, + "type" : "boolean" + }, + "userCount" : { + "description" : "The number of users belonging to the group", + "format" : "int32", + "type" : "integer" + }, + "workspaces" : { + "items" : { + "$ref" : "#/components/schemas/UserManagementWorkspacePermissionAssignment" }, - "description": "Request successfully processed" + "type" : "array" } }, - "summary": "Post Color Pallettes", - "tags": [ - "Appearance", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/entities/colorPalettes/{id}": { - "delete": { - "operationId": "deleteEntity@ColorPalettes", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;content==JsonNodeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete a Color Pallette", - "tags": [ - "Appearance", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "required" : [ "dataSources", "id", "organizationAdmin", "userCount", "workspaces" ], + "type" : "object" }, - "get": { - "operationId": "getEntity@ColorPalettes", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;content==JsonNodeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" - } - } + "UserManagementUsers" : { + "properties" : { + "totalCount" : { + "description" : "The total number of users is based on applied filters.", + "format" : "int32", + "type" : "integer" + }, + "users" : { + "items" : { + "$ref" : "#/components/schemas/UserManagementUsersItem" }, - "description": "Request successfully processed" + "type" : "array" } }, - "summary": "Get Color Pallette", - "tags": [ - "Appearance", - "entities", - "organization-model-controller" - ] + "required" : [ "totalCount", "users" ], + "type" : "object" }, - "patch": { - "operationId": "patchEntity@ColorPalettes", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" + "UserManagementUsersItem" : { + "description" : "List of users", + "properties" : { + "dataSources" : { + "items" : { + "$ref" : "#/components/schemas/UserManagementDataSourcePermissionAssignment" + }, + "type" : "array" }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;content==JsonNodeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiColorPalettePatchDocument" - } + "email" : { + "description" : "User email address", + "example" : "user@example.com", + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "name" : { + "description" : "User name", + "example" : "John Wick", + "type" : "string" + }, + "organizationAdmin" : { + "description" : "Is user organization admin", + "example" : false, + "type" : "boolean" + }, + "userGroups" : { + "items" : { + "$ref" : "#/components/schemas/UserGroupIdentifier" }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiColorPalettePatchDocument" - } - } + "type" : "array" }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" - } - } + "workspaces" : { + "items" : { + "$ref" : "#/components/schemas/UserManagementWorkspacePermissionAssignment" }, - "description": "Request successfully processed" + "type" : "array" } }, - "summary": "Patch Color Pallette", - "tags": [ - "Appearance", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "required" : [ "dataSources", "id", "organizationAdmin", "userGroups", "workspaces" ], + "type" : "object" }, - "put": { - "operationId": "updateEntity@ColorPalettes", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;content==JsonNodeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" - } + "UserManagementWorkspacePermissionAssignment" : { + "description" : "Workspace permission assignments for users and userGroups", + "properties" : { + "hierarchyPermissions" : { + "items" : { + "enum" : [ "MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "CREATE_FILTER_VIEW", "VIEW" ], + "type" : "string" }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" - } - } + "type" : "array" }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" - } - } + "id" : { + "type" : "string" + }, + "name" : { + "readOnly" : true, + "type" : "string" + }, + "permissions" : { + "items" : { + "enum" : [ "MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "CREATE_FILTER_VIEW", "VIEW" ], + "type" : "string" }, - "description": "Request successfully processed" + "type" : "array" } }, - "summary": "Put Color Pallette", - "tags": [ - "Appearance", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/entities/cspDirectives": { - "get": { - "description": " Context Security Police Directive", - "operationId": "getAllEntities@CspDirectives", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "sources==v1,v2,v3", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" + "required" : [ "hierarchyPermissions", "id", "permissions" ], + "type" : "object" + }, + "UserPermission" : { + "description" : "List of users", + "properties" : { + "email" : { + "description" : "User email address", + "example" : "user@example.com", + "type" : "string" }, - { - "$ref": "#/components/parameters/size" + "id" : { + "type" : "string" }, - { - "$ref": "#/components/parameters/sort" + "name" : { + "description" : "Name of user", + "example" : "John Wick", + "type" : "string" }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true + "permissions" : { + "description" : "Permissions granted to the user", + "items" : { + "$ref" : "#/components/schemas/GrantedPermission" }, - "style": "form" + "type" : "array" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutList" - } - } - }, - "description": "Request successfully processed" + }, + "required" : [ "id" ], + "type" : "object" + }, + "Value" : { + "properties" : { + "value" : { + "description" : "Value of the alert threshold to compare the metric to.", + "example" : 1000, + "type" : "number" + } + }, + "required" : [ "value" ], + "type" : "object" + }, + "VisibleFilter" : { + "properties" : { + "isAllTimeDateFilter" : { + "default" : false, + "description" : "Indicates if the filter is an all-time date filter. Such a filter is not included in report computation, so there is no filter with the same 'localIdentifier' to be found. In such cases, this flag is used to inform the server to not search for the filter in the definitions and include it anyways.", + "type" : "boolean" + }, + "localIdentifier" : { + "type" : "string" + }, + "title" : { + "type" : "string" + } + }, + "type" : "object" + }, + "VisualExportRequest" : { + "description" : "Export request object describing the export properties and metadata for dashboard PDF exports.", + "properties" : { + "dashboardId" : { + "description" : "Dashboard identifier", + "example" : "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type" : "string" + }, + "fileName" : { + "description" : "File name to be used for retrieving the pdf document.", + "example" : "filename", + "type" : "string" + }, + "metadata" : { + "description" : "Metadata definition in free-form JSON format.", + "example" : "{}", + "type" : "object" + } + }, + "required" : [ "dashboardId", "fileName" ], + "type" : "object" + }, + "Webhook" : { + "allOf" : [ { + "properties" : { + "hasSecretKey" : { + "description" : "Flag indicating if webhook has a hmac secret key.", + "maxLength" : 10000, + "nullable" : true, + "readOnly" : true, + "type" : "boolean" + }, + "hasToken" : { + "description" : "Flag indicating if webhook has a token.", + "maxLength" : 10000, + "nullable" : true, + "readOnly" : true, + "type" : "boolean" + }, + "secretKey" : { + "description" : "Hmac secret key for the webhook signature.", + "example" : "secret_key", + "maxLength" : 10000, + "nullable" : true, + "type" : "string", + "writeOnly" : true + }, + "token" : { + "description" : "Bearer token for the webhook.", + "example" : "secret", + "maxLength" : 10000, + "nullable" : true, + "type" : "string", + "writeOnly" : true + }, + "type" : { + "description" : "The destination type.", + "enum" : [ "WEBHOOK" ], + "type" : "string" + }, + "url" : { + "description" : "The webhook URL.", + "example" : "https://webhook.site/something", + "maxLength" : 255, + "pattern" : "https?\\://.*", + "type" : "string" + } + }, + "type" : "object" + } ], + "description" : "Webhook destination for notifications. The property url is required on create and update.", + "required" : [ "type" ], + "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, + "properties" : { + "appliedOn" : { + "description" : "Export types this template applies to.", + "example" : [ "PDF", "PPTX" ], + "items" : { + "enum" : [ "PDF", "PPTX" ], + "type" : "string" + }, + "minItems" : 1, + "type" : "array" + }, + "contentSlide" : { + "$ref" : "#/components/schemas/ContentSlideTemplate" + } + }, + "required" : [ "appliedOn" ], + "type" : "object" + }, + "WorkspaceAutomationIdentifier" : { + "properties" : { + "id" : { + "type" : "string" + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "WorkspaceAutomationManagementBulkRequest" : { + "properties" : { + "automations" : { + "items" : { + "$ref" : "#/components/schemas/WorkspaceAutomationIdentifier" + }, + "type" : "array" + } + }, + "required" : [ "automations" ], + "type" : "object" + }, + "WorkspaceDataSource" : { + "description" : "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", + "properties" : { + "id" : { + "description" : "The ID of the used data source.", + "example" : "snowflake.instance.1", + "type" : "string" + }, + "schemaPath" : { + "description" : "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", + "items" : { + "description" : "The part of the schema path.", + "example" : "subPath", + "type" : "string" + }, + "type" : "array" + } + }, + "required" : [ "id" ], + "type" : "object" + }, + "WorkspaceIdentifier" : { + "description" : "A workspace identifier.", + "example" : "{ id: demo, type: workspace }", + "properties" : { + "id" : { + "description" : "Identifier of the workspace.", + "example" : "alpha.sales", + "pattern" : "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type" : "string" + }, + "type" : { + "description" : "A type.", + "enum" : [ "workspace" ], + "example" : "workspace", + "type" : "string" } }, - "summary": "Get CSP Directives", - "tags": [ - "CSP Directives", - "entities", - "organization-model-controller" - ] + "required" : [ "id", "type" ], + "type" : "object" }, - "post": { - "description": " Context Security Police Directive", - "operationId": "createEntity@CspDirectives", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" - } + "WorkspacePermissionAssignment" : { + "description" : "Workspace permission assignments", + "properties" : { + "assigneeIdentifier" : { + "$ref" : "#/components/schemas/AssigneeIdentifier" + }, + "hierarchyPermissions" : { + "items" : { + "enum" : [ "MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "CREATE_FILTER_VIEW", "VIEW" ], + "type" : "string" }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" - } - } + "type" : "array" }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" - } - } + "permissions" : { + "items" : { + "enum" : [ "MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "CREATE_FILTER_VIEW", "VIEW" ], + "type" : "string" }, - "description": "Request successfully processed" + "type" : "array" } }, - "summary": "Post CSP Directives", - "tags": [ - "CSP Directives", - "entities", - "organization-model-controller" - ] - } - }, - "/api/v1/entities/cspDirectives/{id}": { - "delete": { - "description": " Context Security Police Directive", - "operationId": "deleteEntity@CspDirectives", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "sources==v1,v2,v3", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "required" : [ "assigneeIdentifier" ], + "type" : "object" + }, + "WorkspaceUser" : { + "description" : "List of workspace users", + "properties" : { + "email" : { + "description" : "User email address", + "example" : "user@example.com", + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "name" : { + "description" : "User name", + "example" : "John Wick", + "type" : "string" } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete CSP Directives", - "tags": [ - "CSP Directives", - "entities", - "organization-model-controller" - ] - }, - "get": { - "description": " Context Security Police Directive", - "operationId": "getEntity@CspDirectives", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "sources==v1,v2,v3", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + }, + "required" : [ "id" ], + "type" : "object" + }, + "WorkspaceUserGroup" : { + "description" : "List of workspace groups", + "properties" : { + "id" : { + "type" : "string" + }, + "name" : { + "description" : "Group name", + "example" : "admins", + "type" : "string" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" - } - } + }, + "required" : [ "id" ], + "type" : "object" + }, + "WorkspaceUserGroups" : { + "properties" : { + "totalCount" : { + "description" : "Total number of groups", + "format" : "int32", + "type" : "integer" + }, + "userGroups" : { + "items" : { + "$ref" : "#/components/schemas/WorkspaceUserGroup" }, - "description": "Request successfully processed" + "type" : "array" } }, - "summary": "Get CSP Directives", - "tags": [ - "CSP Directives", - "entities", - "organization-model-controller" - ] + "required" : [ "totalCount", "userGroups" ], + "type" : "object" }, - "patch": { - "description": " Context Security Police Directive", - "operationId": "patchEntity@CspDirectives", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" + "WorkspaceUsers" : { + "properties" : { + "totalCount" : { + "description" : "The total number of users is based on applied filters.", + "format" : "int32", + "type" : "integer" }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "sources==v1,v2,v3", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "users" : { + "items" : { + "$ref" : "#/components/schemas/WorkspaceUser" + }, + "type" : "array" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectivePatchDocument" - } + }, + "required" : [ "totalCount", "users" ], + "type" : "object" + }, + "Xliff" : { + "properties" : { + "file" : { + "items" : { + "$ref" : "#/components/schemas/File" }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectivePatchDocument" - } - } + "type" : "array" }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" - } - } + "otherAttributes" : { + "additionalProperties" : { + "type" : "string" }, - "description": "Request successfully processed" + "type" : "object" + }, + "space" : { + "type" : "string", + "xml" : { + "attribute" : true, + "namespace" : "http://www.w3.org/XML/1998/namespace" + } + }, + "srcLang" : { + "type" : "string", + "xml" : { + "attribute" : true + } + }, + "trgLang" : { + "type" : "string", + "xml" : { + "attribute" : true + } + }, + "version" : { + "type" : "string", + "xml" : { + "attribute" : true + } } }, - "summary": "Patch CSP Directives", - "tags": [ - "CSP Directives", - "entities", - "organization-model-controller" - ] + "required" : [ "file" ], + "type" : "object", + "xml" : { + "name" : "xliff", + "namespace" : "urn:oasis:names:tc:xliff:document:2.0" + } + } + } + }, + "info" : { + "title" : "OpenAPI definition", + "version" : "v0" + }, + "openapi" : "3.0.1", + "paths" : { + "/api/v1/aac/workspaces/{workspaceId}/analyticsModel" : { + "get" : { + "description" : "\n Retrieve the analytics model of the workspace in Analytics as Code format.\n \n The returned format is compatible with the YAML definitions used by the \n GoodData Analytics as Code VSCode extension. This includes metrics, \n dashboards, visualizations, plugins, and attribute hierarchies.\n ", + "operationId" : "getAnalyticsModelAac", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "exclude", + "required" : false, + "schema" : { + "items" : { + "description" : "Defines properties which should not be included in the payload.", + "enum" : [ "ACTIVITY_INFO" ], + "type" : "string" + }, + "type" : "array" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AacAnalyticsModel" + } + } + }, + "description" : "Retrieved current analytics model in AAC format." + } + }, + "summary" : "Get analytics model in AAC format", + "tags" : [ "aac", "AAC - Analytics Model" ], + "x-gdc-security-info" : { + "description" : "Permissions to read the analytics layout.", + "permissions" : [ "ANALYZE" ] + } }, - "put": { - "description": " Context Security Police Directive", - "operationId": "updateEntity@CspDirectives", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "sources==v1,v2,v3", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "put" : { + "description" : "\n Set the analytics model of the workspace using Analytics as Code format.\n \n The input format is compatible with the YAML definitions used by the \n GoodData Analytics as Code VSCode extension. This replaces the entire \n analytics model with the provided definition, including metrics, \n dashboards, visualizations, plugins, and attribute hierarchies.\n ", + "operationId" : "setAnalyticsModelAac", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AacAnalyticsModel" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" - } - } - }, - "description": "Request successfully processed" + "responses" : { + "204" : { + "description" : "Analytics model successfully set." } }, - "summary": "Put CSP Directives", - "tags": [ - "CSP Directives", - "entities", - "organization-model-controller" - ] + "summary" : "Set analytics model from AAC format", + "tags" : [ "aac", "AAC - Analytics Model" ], + "x-gdc-security-info" : { + "description" : "Permissions to modify the analytics layout.", + "permissions" : [ "ANALYZE" ] + } } }, - "/api/v1/entities/customGeoCollections": { - "get": { - "operationId": "getAllEntities@CustomGeoCollections", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "", - "in": "query", - "name": "filter", - "schema": { - "type": "string" + "/api/v1/aac/workspaces/{workspaceId}/logicalModel" : { + "get" : { + "description" : "\n Retrieve the logical data model of the workspace in Analytics as Code format.\n \n The returned format is compatible with the YAML definitions used by the \n GoodData Analytics as Code VSCode extension. Use this for exporting models\n that can be directly used as YAML configuration files.\n ", + "operationId" : "getLogicalModelAac", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "includeParents", + "required" : false, + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AacLogicalModel" + } + } + }, + "description" : "Retrieved current logical model in AAC format." + } + }, + "summary" : "Get logical model in AAC format", + "tags" : [ "aac", "AAC - Logical Data Model" ], + "x-gdc-security-info" : { + "description" : "Permissions to read the logical model.", + "permissions" : [ "VIEW" ] + } + }, + "put" : { + "description" : "\n Set the logical data model of the workspace using Analytics as Code format.\n \n The input format is compatible with the YAML definitions used by the \n GoodData Analytics as Code VSCode extension. This replaces the entire \n logical model with the provided definition.\n ", + "operationId" : "setLogicalModelAac", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AacLogicalModel" + } } }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" + "required" : true + }, + "responses" : { + "204" : { + "description" : "Logical model successfully set." } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutList" + }, + "summary" : "Set logical model from AAC format", + "tags" : [ "aac", "AAC - Logical Data Model" ], + "x-gdc-security-info" : { + "description" : "Permissions required to alter the logical model.", + "permissions" : [ "MANAGE" ] + } + } + }, + "/api/v1/actions/collectUsage" : { + "get" : { + "description" : "Provides information about platform usage, like amount of users, workspaces, ...\n\n_NOTE_: The `admin` user is always excluded from this amount.", + "operationId" : "allPlatformUsage", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/PlatformUsage" + }, + "type" : "array" } } }, - "description": "Request successfully processed" + "description" : "OK" } }, - "tags": [ - "Geographic Data", - "entities", - "organization-model-controller" - ] + "summary" : "Info about the platform usage.", + "tags" : [ "Usage", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "MANAGE" ] + } }, - "post": { - "operationId": "createEntity@CustomGeoCollections", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" + "post" : { + "description" : "Provides information about platform usage, like amount of users, workspaces, ...\n\n_NOTE_: The `admin` user is always excluded from this amount.", + "operationId" : "particularPlatformUsage", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PlatformUsageRequest" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/PlatformUsage" + }, + "type" : "array" } } }, - "description": "Request successfully processed" + "description" : "OK" } }, - "tags": [ - "Geographic Data", - "entities", - "organization-model-controller" - ] + "summary" : "Info about the platform usage for particular items.", + "tags" : [ "Usage", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "MANAGE" ] + } } }, - "/api/v1/entities/customGeoCollections/{id}": { - "delete": { - "operationId": "deleteEntity@CustomGeoCollections", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "/api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel" : { + "post" : { + "description" : "Generate logical data model (LDM) from physical data model (PDM) stored in data source.", + "operationId" : "generateLogicalModel", + "parameters" : [ { + "in" : "path", + "name" : "dataSourceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "tags": [ - "Geographic Data", - "entities", - "organization-model-controller" - ] - }, - "get": { - "operationId": "getEntity@CustomGeoCollections", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "", - "in": "query", - "name": "filter", - "schema": { - "type": "string" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GenerateLdmRequest" + } } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + }, + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeModel" } } }, - "description": "Request successfully processed" + "description" : "LDM generated successfully." } }, - "tags": [ - "Geographic Data", - "entities", - "organization-model-controller" - ] - }, - "patch": { - "operationId": "patchEntity@CustomGeoCollections", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "summary" : "Generate logical data model (LDM) from physical data model (PDM)", + "tags" : [ "Generate Logical Data Model", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "MANAGE" ] + } + } + }, + "/api/v1/actions/dataSources/{dataSourceId}/generateLogicalModelAac" : { + "post" : { + "description" : "\n Generate logical data model (LDM) from physical data model (PDM) stored in data source,\n returning the result in Analytics as Code (AAC) format compatible with the GoodData \n VSCode extension YAML definitions.\n ", + "operationId" : "generateLogicalModelAac", + "parameters" : [ { + "in" : "path", + "name" : "dataSourceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionPatchDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GenerateLdmRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AacLogicalModel" } } }, - "description": "Request successfully processed" + "description" : "LDM generated successfully in AAC format." } }, - "tags": [ - "Geographic Data", - "entities", - "organization-model-controller" - ] - }, - "put": { - "operationId": "updateEntity@CustomGeoCollections", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "summary" : "Generate logical data model in AAC format from physical data model (PDM)", + "tags" : [ "Generate Logical Data Model", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "MANAGE" ] + } + } + }, + "/api/v1/actions/dataSources/{dataSourceId}/managePermissions" : { + "post" : { + "description" : "Manage Permissions for a Data Source", + "operationId" : "manageDataSourcePermissions", + "parameters" : [ { + "in" : "path", + "name" : "dataSourceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "description" : "An array of data source permissions assignments", + "items" : { + "$ref" : "#/components/schemas/DataSourcePermissionAssignment" + }, + "type" : "array" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" - } - } - }, - "description": "Request successfully processed" + "responses" : { + "204" : { + "description" : "No Content" } }, - "tags": [ - "Geographic Data", - "entities", - "organization-model-controller" - ] + "summary" : "Manage Permissions for a Data Source", + "tags" : [ "Manage Permissions", "Permissions", "actions" ] } }, - "/api/v1/entities/dataSourceIdentifiers": { - "get": { - "operationId": "getAllEntities@DataSourceIdentifiers", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;schema==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Data Source Identifiers", - "tags": [ - "Data Source - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "USE" - ] + "/api/v1/actions/dataSources/{dataSourceId}/uploadNotification" : { + "post" : { + "description" : "Notification sets up all reports to be computed again with new data.", + "operationId" : "registerUploadNotification", + "parameters" : [ { + "in" : "path", + "name" : "dataSourceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "An upload notification has been successfully registered." + } + }, + "summary" : "Register an upload notification", + "tags" : [ "Invalidate Cache", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/dataSourceIdentifiers/{id}": { - "get": { - "operationId": "getEntity@DataSourceIdentifiers", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;schema==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" + "/api/v1/actions/organization/automations/delete" : { + "post" : { + "operationId" : "deleteOrganizationAutomations", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationAutomationManagementBulkRequest" + } } }, - { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get Data Source Identifier", - "tags": [ - "Data Source - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "USE" - ] - } + "required" : true + }, + "responses" : { + "204" : { + "description" : "No Content" + } + }, + "summary" : "Delete selected automations across all workspaces", + "tags" : [ "Automations", "actions" ] } }, - "/api/v1/entities/dataSources": { - "get": { - "description": "Data Source - represents data source for the workspace", - "operationId": "getAllEntities@DataSources", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;type==DatabaseTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get Data Source entities", - "tags": [ - "Data Source - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "post": { - "description": "Data Source - represents data source for the workspace", - "operationId": "createEntity@DataSources", - "parameters": [ - { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceInDocument" + "/api/v1/actions/organization/automations/pause" : { + "post" : { + "operationId" : "pauseOrganizationAutomations", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationAutomationManagementBulkRequest" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" - } - } - }, - "description": "Request successfully processed" + "responses" : { + "204" : { + "description" : "No Content" } }, - "summary": "Post Data Sources", - "tags": [ - "Data Source - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "summary" : "Pause selected automations across all workspaces", + "tags" : [ "Automations", "actions" ] } }, - "/api/v1/entities/dataSources/{id}": { - "delete": { - "description": "Data Source - represents data source for the workspace", - "operationId": "deleteEntity@DataSources", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;type==DatabaseTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete Data Source entity", - "tags": [ - "Data Source - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "get": { - "description": "Data Source - represents data source for the workspace", - "operationId": "getEntity@DataSources", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;type==DatabaseTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get Data Source entity", - "tags": [ - "Data Source - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "patch": { - "description": "Data Source - represents data source for the workspace", - "operationId": "patchEntity@DataSources", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;type==DatabaseTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourcePatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourcePatchDocument" + "/api/v1/actions/organization/automations/unpause" : { + "post" : { + "operationId" : "unpauseOrganizationAutomations", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationAutomationManagementBulkRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" - } - } - }, - "description": "Request successfully processed" + "responses" : { + "204" : { + "description" : "No Content" } }, - "summary": "Patch Data Source entity", - "tags": [ - "Data Source - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "put": { - "description": "Data Source - represents data source for the workspace", - "operationId": "updateEntity@DataSources", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;type==DatabaseTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "summary" : "Unpause selected automations across all workspaces", + "tags" : [ "Automations", "actions" ] + } + }, + "/api/v1/actions/organization/automations/unsubscribe" : { + "delete" : { + "operationId" : "unsubscribeAllAutomations", + "responses" : { + "204" : { + "description" : "No Content" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceInDocument" + }, + "summary" : "Unsubscribe from all automations in all workspaces", + "tags" : [ "Automations", "actions" ] + }, + "post" : { + "operationId" : "unsubscribeOrganizationAutomations", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationAutomationManagementBulkRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" - } - } - }, - "description": "Request successfully processed" + "responses" : { + "204" : { + "description" : "No Content" } }, - "summary": "Put Data Source entity", - "tags": [ - "Data Source - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "summary" : "Unsubscribe from selected automations across all workspaces", + "tags" : [ "Automations", "actions" ] } }, - "/api/v1/entities/entitlements": { - "get": { - "description": "Space of the shared interest", - "operationId": "getAllEntities@Entitlements", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "value==someString;expiry==LocalDateValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" + "/api/v1/actions/organization/managePermissions" : { + "post" : { + "description" : "Manage Permissions for a Organization", + "operationId" : "manageOrganizationPermissions", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "description" : "An array of organization permissions assignments", + "items" : { + "$ref" : "#/components/schemas/OrganizationPermissionAssignment" + }, + "type" : "array" + } } }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiEntitlementOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiEntitlementOutList" - } - } - }, - "description": "Request successfully processed" + "required" : true + }, + "responses" : { + "204" : { + "description" : "No Content" } }, - "summary": "Get Entitlements", - "tags": [ - "Entitlement", - "entities", - "organization-model-controller" - ] + "summary" : "Manage Permissions for a Organization", + "tags" : [ "Permissions", "actions" ] } }, - "/api/v1/entities/entitlements/{id}": { - "get": { - "description": "Space of the shared interest", - "operationId": "getEntity@Entitlements", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "value==someString;expiry==LocalDateValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "/api/v1/actions/organization/metadataCheck" : { + "post" : { + "description" : "(BETA) Temporary solution. Resyncs all organization objects and full workspaces within the organization with target GEN_AI_CHECK.", + "operationId" : "metadataCheckOrganization", + "responses" : { + "200" : { + "description" : "OK" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiEntitlementOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiEntitlementOutDocument" - } - } - }, - "description": "Request successfully processed" + }, + "summary" : "(BETA) Check Organization Metadata Inconsistencies", + "tags" : [ "AI", "Metadata Check", "actions" ] + } + }, + "/api/v1/actions/organization/metadataSync" : { + "post" : { + "description" : "(BETA) Temporary solution. Later relevant metadata actions will trigger sync in their scope only.", + "operationId" : "metadataSyncOrganization", + "responses" : { + "200" : { + "description" : "OK" } }, - "summary": "Get Entitlement", - "tags": [ - "Entitlement", - "entities", - "organization-model-controller" - ] + "summary" : "(BETA) Sync organization scope Metadata to other services", + "tags" : [ "AI", "Metadata Sync", "actions" ] } }, - "/api/v1/entities/exportTemplates": { - "get": { - "operationId": "getAllEntities@ExportTemplates", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" + "/api/v1/actions/organization/switchActiveIdentityProvider" : { + "post" : { + "description" : "Switch the active identity provider for the organization. Requires MANAGE permission on the organization.", + "operationId" : "switchActiveIdentityProvider", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SwitchIdentityProviderRequest" + } } }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" + "required" : true + }, + "responses" : { + "204" : { + "description" : "No Content" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutList" + }, + "summary" : "Switch Active Identity Provider", + "tags" : [ "Organization", "actions" ] + } + }, + "/api/v1/actions/resolveEntitlements" : { + "get" : { + "description" : "Resolves values of available entitlements for the organization.", + "operationId" : "resolveAllEntitlements", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/ApiEntitlement" + }, + "type" : "array" } } }, - "description": "Request successfully processed" + "description" : "OK" } }, - "summary": "GET all Export Template entities", - "tags": [ - "Export templates", - "entities", - "organization-model-controller" - ] + "summary" : "Values for all public entitlements.", + "tags" : [ "Entitlement", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "VIEW" ] + } }, - "post": { - "operationId": "createEntity@ExportTemplates", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalIdDocument" + "post" : { + "description" : "Resolves values for requested entitlements in the organization.", + "operationId" : "resolveRequestedEntitlements", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitlementsRequest" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/ApiEntitlement" + }, + "type" : "array" } } }, - "description": "Request successfully processed" + "description" : "OK" } }, - "summary": "Post Export Template entities", - "tags": [ - "Export templates", - "entities", - "organization-model-controller" - ] + "summary" : "Values for requested public entitlements.", + "tags" : [ "Entitlement", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "VIEW" ] + } } }, - "/api/v1/entities/exportTemplates/{id}": { - "delete": { - "operationId": "deleteEntity@ExportTemplates", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete Export Template entity", - "tags": [ - "Export templates", - "entities", - "organization-model-controller" - ] - }, - "get": { - "operationId": "getEntity@ExportTemplates", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "/api/v1/actions/resolveSettings" : { + "get" : { + "description" : "Resolves values for all settings without workspace by current user, organization, or default settings.", + "operationId" : "resolveAllSettingsWithoutWorkspace", + "parameters" : [ { + "description" : "If true, user-level settings are excluded from resolution.", + "in" : "query", + "name" : "excludeUserSettings", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/ResolvedSetting" + }, + "type" : "array" } } }, - "description": "Request successfully processed" + "description" : "Values for selected settings." } }, - "summary": "GET Export Template entity", - "tags": [ - "Export templates", - "entities", - "organization-model-controller" - ] + "summary" : "Values for all settings without workspace.", + "tags" : [ "Reporting - Settings", "actions" ] }, - "patch": { - "operationId": "patchEntity@ExportTemplates", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "post" : { + "description" : "Resolves values for selected settings without workspace by current user, organization, or default settings.", + "operationId" : "resolveSettingsWithoutWorkspace", + "parameters" : [ { + "description" : "If true, user-level settings are excluded from resolution.", + "in" : "query", + "name" : "excludeUserSettings", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplatePatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplatePatchDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResolveSettingsRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/ResolvedSetting" + }, + "type" : "array" } } }, - "description": "Request successfully processed" + "description" : "Values for selected settings." } }, - "summary": "Patch Export Template entity", - "tags": [ - "Export templates", - "entities", - "organization-model-controller" - ] - }, - "put": { - "operationId": "updateEntity@ExportTemplates", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" + "summary" : "Values for selected settings without workspace.", + "tags" : [ "Reporting - Settings", "actions" ] + } + }, + "/api/v1/actions/userManagement/assignPermissions" : { + "post" : { + "operationId" : "assignPermissions", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PermissionsAssignment" + } + } }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK" + } + }, + "tags" : [ "User management" ] + } + }, + "/api/v1/actions/userManagement/removeUsersUserGroups" : { + "post" : { + "operationId" : "removeUsersUserGroups", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/AssigneeIdentifier" + }, + "type" : "array" + } } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateInDocument" + }, + "tags" : [ "User management" ] + } + }, + "/api/v1/actions/userManagement/revokePermissions" : { + "post" : { + "operationId" : "revokePermissions", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PermissionsAssignment" } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateInDocument" + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK" + } + }, + "tags" : [ "User management" ] + } + }, + "/api/v1/actions/userManagement/userGroups" : { + "get" : { + "operationId" : "listUserGroups", + "parameters" : [ { + "description" : "Zero-based page index (0..N)", + "example" : "page=0", + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : 0, + "format" : "int32", + "type" : "integer" + }, + "style" : "form" + }, { + "description" : "The size of the page to be returned.", + "example" : "size=20", + "in" : "query", + "name" : "size", + "required" : false, + "schema" : { + "default" : 20, + "format" : "int32", + "type" : "integer" + }, + "style" : "form" + }, { + "description" : "Filter by user name. Note that user name is case insensitive.", + "example" : "name=charles", + "in" : "query", + "name" : "name", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Filter by workspaceId.", + "example" : "workspace=demo", + "in" : "query", + "name" : "workspace", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Filter by dataSourceId.", + "example" : "dataSource=demo-test-ds", + "in" : "query", + "name" : "dataSource", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UserManagementUserGroups" + } + } + }, + "description" : "OK" + } + }, + "tags" : [ "User management" ] + } + }, + "/api/v1/actions/userManagement/userGroups/{userGroupId}/addMembers" : { + "post" : { + "operationId" : "addGroupMembers", + "parameters" : [ { + "in" : "path", + "name" : "userGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UserManagementUserGroupMembers" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "responses" : { + "204" : { + "description" : "No Content" + } + }, + "tags" : [ "User management" ] + } + }, + "/api/v1/actions/userManagement/userGroups/{userGroupId}/members" : { + "get" : { + "operationId" : "getGroupMembers", + "parameters" : [ { + "in" : "path", + "name" : "userGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UserManagementUserGroupMembers" } } }, - "description": "Request successfully processed" + "description" : "OK" } }, - "summary": "PUT Export Template entity", - "tags": [ - "Export templates", - "entities", - "organization-model-controller" - ] + "tags" : [ "User management" ] } }, - "/api/v1/entities/identityProviders": { - "get": { - "operationId": "getAllEntities@IdentityProviders", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" + "/api/v1/actions/userManagement/userGroups/{userGroupId}/permissions" : { + "get" : { + "operationId" : "listPermissionsForUserGroup", + "parameters" : [ { + "in" : "path", + "name" : "userGroupId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutList" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UserManagementPermissionAssignments" } } }, - "description": "Request successfully processed" + "description" : "OK" } }, - "summary": "Get all Identity Providers", - "tags": [ - "Identity Providers", - "entities", - "organization-model-controller" - ] + "tags" : [ "User management" ] }, - "post": { - "operationId": "createEntity@IdentityProviders", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" + "post" : { + "operationId" : "managePermissionsForUserGroup", + "parameters" : [ { + "in" : "path", + "name" : "userGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UserManagementPermissionAssignments" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } - } - }, - "description": "Request successfully processed" + "responses" : { + "204" : { + "description" : "No Content" } }, - "summary": "Post Identity Providers", - "tags": [ - "Identity Providers", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "tags" : [ "User management" ] } }, - "/api/v1/entities/identityProviders/{id}": { - "delete": { - "operationId": "deleteEntity@IdentityProviders", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "/api/v1/actions/userManagement/userGroups/{userGroupId}/removeMembers" : { + "post" : { + "operationId" : "removeGroupMembers", + "parameters" : [ { + "in" : "path", + "name" : "userGroupId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete Identity Provider", - "tags": [ - "Identity Providers", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "get": { - "operationId": "getEntity@IdentityProviders", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UserManagementUserGroupMembers" + } } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "No Content" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" + }, + "tags" : [ "User management" ] + } + }, + "/api/v1/actions/userManagement/users" : { + "get" : { + "operationId" : "listUsers", + "parameters" : [ { + "description" : "Zero-based page index (0..N)", + "example" : "page=0", + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : 0, + "format" : "int32", + "type" : "integer" + }, + "style" : "form" + }, { + "description" : "The size of the page to be returned.", + "example" : "size=20", + "in" : "query", + "name" : "size", + "required" : false, + "schema" : { + "default" : 20, + "format" : "int32", + "type" : "integer" + }, + "style" : "form" + }, { + "description" : "Filter by user name. Note that user name is case insensitive.", + "example" : "name=charles", + "in" : "query", + "name" : "name", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Filter by workspaceId.", + "example" : "workspace=demo", + "in" : "query", + "name" : "workspace", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Filter by userGroupId.", + "example" : "group=admin", + "in" : "query", + "name" : "group", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + }, { + "description" : "Filter by dataSourceId.", + "example" : "dataSource=demo-test-ds", + "in" : "query", + "name" : "dataSource", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UserManagementUsers" + } + } + }, + "description" : "OK" + } + }, + "tags" : [ "User management" ] + } + }, + "/api/v1/actions/userManagement/users/{userId}/permissions" : { + "get" : { + "operationId" : "listPermissionsForUser", + "parameters" : [ { + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UserManagementPermissionAssignments" } } }, - "description": "Request successfully processed" + "description" : "OK" } }, - "summary": "Get Identity Provider", - "tags": [ - "Identity Providers", - "entities", - "organization-model-controller" - ] + "tags" : [ "User management" ] }, - "patch": { - "operationId": "patchEntity@IdentityProviders", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "post" : { + "operationId" : "managePermissionsForUser", + "parameters" : [ { + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderPatchDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UserManagementPermissionAssignments" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } - } - }, - "description": "Request successfully processed" + "responses" : { + "204" : { + "description" : "No Content" } }, - "summary": "Patch Identity Provider", - "tags": [ - "Identity Providers", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "put": { - "operationId": "updateEntity@IdentityProviders", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "tags" : [ "User management" ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees" : { + "get" : { + "operationId" : "availableAssignees", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "dashboardId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AvailableAssignees" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get Available Assignees", + "tags" : [ "Permissions", "actions" ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions" : { + "post" : { + "operationId" : "manageDashboardPermissions", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "dashboardId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "description" : "An array of dashboard permissions assignments", + "items" : { + "oneOf" : [ { + "$ref" : "#/components/schemas/PermissionsForAssignee" + }, { + "$ref" : "#/components/schemas/PermissionsForAssigneeRule" + } ] + }, + "type" : "array" + } + } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "No Content" + } + }, + "summary" : "Manage Permissions for a Dashboard", + "tags" : [ "Permissions", "actions" ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions" : { + "get" : { + "operationId" : "dashboardPermissions", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "dashboardId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DashboardPermissions" + } + } + }, + "description" : "OK" + } + }, + "summary" : "Get Dashboard Permissions", + "tags" : [ "Permissions", "actions" ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/automations/delete" : { + "post" : { + "operationId" : "deleteWorkspaceAutomations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/WorkspaceAutomationManagementBulkRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } - } - }, - "description": "Request successfully processed" + "responses" : { + "204" : { + "description" : "No Content" } }, - "summary": "Put Identity Provider", - "tags": [ - "Identity Providers", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "summary" : "Delete selected automations in the workspace", + "tags" : [ "Automations", "actions" ] } }, - "/api/v1/entities/jwks": { - "get": { - "description": "Returns all JSON web keys - used to verify JSON web tokens (Jwts)", - "operationId": "getAllEntities@Jwks", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JwkSpecificationValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" + "/api/v1/actions/workspaces/{workspaceId}/automations/pause" : { + "post" : { + "operationId" : "pauseWorkspaceAutomations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/WorkspaceAutomationManagementBulkRequest" + } } }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" + "required" : true + }, + "responses" : { + "204" : { + "description" : "No Content" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutList" - } + }, + "summary" : "Pause selected automations in the workspace", + "tags" : [ "Automations", "actions" ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/automations/unpause" : { + "post" : { + "operationId" : "unpauseWorkspaceAutomations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/WorkspaceAutomationManagementBulkRequest" } - }, - "description": "Request successfully processed" + } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "No Content" + } + }, + "summary" : "Unpause selected automations in the workspace", + "tags" : [ "Automations", "actions" ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe" : { + "delete" : { + "operationId" : "unsubscribeWorkspaceAutomations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No Content" } }, - "summary": "Get all Jwks", - "tags": [ - "JWKS", - "entities", - "organization-model-controller" - ] + "summary" : "Unsubscribe from all automations in the workspace", + "tags" : [ "Automations", "actions" ] }, - "post": { - "description": "Creates JSON web key - used to verify JSON web tokens (Jwts)", - "operationId": "createEntity@Jwks", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiJwkInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiJwkInDocument" + "post" : { + "operationId" : "unsubscribeSelectedWorkspaceAutomations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/WorkspaceAutomationManagementBulkRequest" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "responses" : { + "204" : { + "description" : "No Content" + } + }, + "summary" : "Unsubscribe from selected automations in the workspace", + "tags" : [ "Automations", "actions" ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe" : { + "delete" : { + "operationId" : "unsubscribeAutomation", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "automationId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No Content" + } + }, + "summary" : "Unsubscribe from an automation", + "tags" : [ "Automations", "actions" ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides" : { + "post" : { + "description" : "Finds entities with given ID in hierarchy (e.g. to check possible future conflicts).", + "operationId" : "checkEntityOverrides", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "description" : "An array of object identifications", + "items" : { + "$ref" : "#/components/schemas/HierarchyObjectIdentification" + }, + "type" : "array" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/IdentifierDuplications" + }, + "type" : "array" } } }, - "description": "Request successfully processed" + "description" : "Searching for entities finished successfully." } }, - "summary": "Post Jwks", - "tags": [ - "JWKS", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "summary" : "Finds entities with given ID in hierarchy.", + "tags" : [ "Hierarchy", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "ANALYZE" ] } } }, - "/api/v1/entities/jwks/{id}": { - "delete": { - "description": "Deletes JSON web key - used to verify JSON web tokens (Jwts)", - "operationId": "deleteEntity@Jwks", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JwkSpecificationValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete Jwk", - "tags": [ - "JWKS", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "/api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph" : { + "get" : { + "description" : "Computes the dependent entities graph", + "operationId" : "getDependentEntitiesGraph", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DependentEntitiesResponse" + } + } + }, + "description" : "Computes the dependent entities graph" + } + }, + "summary" : "Computes the dependent entities graph", + "tags" : [ "Dependency Graph", "actions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to read the graph.", + "permissions" : [ "VIEW" ] } }, - "get": { - "description": "Returns JSON web key - used to verify JSON web tokens (Jwts)", - "operationId": "getEntity@Jwks", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JwkSpecificationValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "post" : { + "description" : "Computes the dependent entities graph from given entry points", + "operationId" : "getDependentEntitiesGraphFromEntryPoints", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DependentEntitiesRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DependentEntitiesResponse" } } }, - "description": "Request successfully processed" + "description" : "Computes the dependent entities graph from given entry points" } }, - "summary": "Get Jwk", - "tags": [ - "JWKS", - "entities", - "organization-model-controller" - ] - }, - "patch": { - "description": "Patches JSON web key - used to verify JSON web tokens (Jwts)", - "operationId": "patchEntity@Jwks", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JwkSpecificationValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiJwkPatchDocument" + "summary" : "Computes the dependent entities graph from given entry points", + "tags" : [ "Dependency Graph", "actions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to read the graph.", + "permissions" : [ "VIEW" ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts" : { + "get" : { + "description" : "Finds API identifier conflicts in given workspace hierarchy.", + "operationId" : "inheritedEntityConflicts", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/IdentifierDuplications" + }, + "type" : "array" + } } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiJwkPatchDocument" - } - } - }, - "required": true + "description" : "Searching for conflicting identifiers finished successfully" + } }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "summary" : "Finds identifier conflicts in workspace hierarchy.", + "tags" : [ "Hierarchy", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "MANAGE" ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/inheritedEntityPrefixes" : { + "get" : { + "description" : "Get used entity prefixes in hierarchy of parent workspaces", + "operationId" : "inheritedEntityPrefixes", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "type" : "string" + }, + "type" : "array" } } }, - "description": "Request successfully processed" + "description" : "Prefixes used in parent entities" } }, - "summary": "Patch Jwk", - "tags": [ - "JWKS", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "summary" : "Get used entity prefixes in hierarchy", + "tags" : [ "Hierarchy", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "VIEW" ] } - }, - "put": { - "description": "Updates JSON web key - used to verify JSON web tokens (Jwts)", - "operationId": "updateEntity@Jwks", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JwkSpecificationValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/managePermissions" : { + "post" : { + "description" : "Manage Permissions for a Workspace and its Workspace Hierarchy", + "operationId" : "manageWorkspacePermissions", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiJwkInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiJwkInDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "description" : "An array of workspace permissions assignments", + "items" : { + "$ref" : "#/components/schemas/WorkspacePermissionAssignment" + }, + "type" : "array" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "responses" : { + "204" : { + "description" : "No Content" + } + }, + "summary" : "Manage Permissions for a Workspace", + "tags" : [ "Permissions", "actions" ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/metadataSync" : { + "post" : { + "description" : "(BETA) Temporary solution. Later relevant metadata actions will trigger it in its scope only.", + "operationId" : "metadataSync", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + } + }, + "summary" : "(BETA) Sync Metadata to other services", + "tags" : [ "AI", "Metadata Sync", "actions" ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities" : { + "get" : { + "description" : "Finds API identifier overrides in given workspace hierarchy.", + "operationId" : "overriddenChildEntities", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/IdentifierDuplications" + }, + "type" : "array" } } }, - "description": "Request successfully processed" + "description" : "Searching for overridden identifiers finished successfully" } }, - "summary": "Put Jwk", - "tags": [ - "JWKS", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "summary" : "Finds identifier overrides in workspace hierarchy.", + "tags" : [ "Hierarchy", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/llmEndpoints": { - "get": { - "operationId": "getAllEntities@LlmEndpoints", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;provider==LLMProviderValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true + "/api/v1/actions/workspaces/{workspaceId}/resolveSettings" : { + "get" : { + "description" : "Resolves values for all settings in a workspace by current user, workspace, organization, or default settings.", + "operationId" : "workspaceResolveAllSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "If true, user-level settings are excluded from resolution.", + "in" : "query", + "name" : "excludeUserSettings", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/ResolvedSetting" + }, + "type" : "array" + } + } }, - "style": "form" + "description" : "Values for selected settings." } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLlmEndpointOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLlmEndpointOutList" + }, + "summary" : "Values for all settings.", + "tags" : [ "Workspaces - Settings", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "VIEW" ] + } + }, + "post" : { + "description" : "Resolves value for selected settings in a workspace by current user, workspace, organization, or default settings.", + "operationId" : "workspaceResolveSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "If true, user-level settings are excluded from resolution.", + "in" : "query", + "name" : "excludeUserSettings", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResolveSettingsRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/ResolvedSetting" + }, + "type" : "array" } } }, - "description": "Request successfully processed" + "description" : "Values for selected settings." } }, - "summary": "Get all LLM endpoint entities", - "tags": [ - "LLM Endpoints", - "entities", - "organization-model-controller" - ] - }, - "post": { - "operationId": "createEntity@LlmEndpoints", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLlmEndpointInDocument" + "summary" : "Values for selected settings.", + "tags" : [ "Workspaces - Settings", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "VIEW" ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/translations" : { + "get" : { + "description" : "Provides a list of effective translation tags.", + "operationId" : "getTranslationTags", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "type" : "string" + }, + "type" : "array" + } } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLlmEndpointInDocument" + "description" : "Retrieved list of translation tags." + } + }, + "summary" : "Get translation tags.", + "tags" : [ "Translations", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "MANAGE" ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/translations/clean" : { + "post" : { + "description" : "Cleans up all translations for a particular locale.", + "operationId" : "cleanTranslations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LocaleRequest" + } + } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "Translations were successfully removed." + } + }, + "summary" : "Cleans up translations.", + "tags" : [ "Translations", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "MANAGE" ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/translations/retrieve" : { + "post" : { + "description" : "Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value.", + "operationId" : "retrieveTranslations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LocaleRequest" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLlmEndpointOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLlmEndpointOutDocument" + "responses" : { + "200" : { + "content" : { + "application/xml" : { + "schema" : { + "$ref" : "#/components/schemas/Xliff" } } }, - "description": "Request successfully processed" + "description" : "XLIFF file containing translations for a particular locale." } }, - "summary": "Post LLM endpoint entities", - "tags": [ - "LLM Endpoints", - "entities", - "organization-model-controller" - ] + "summary" : "Retrieve translations for entities.", + "tags" : [ "Translations", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "MANAGE" ] + } } }, - "/api/v1/entities/llmEndpoints/{id}": { - "delete": { - "operationId": "deleteEntity@LlmEndpoints", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;provider==LLMProviderValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "tags": [ - "LLM Endpoints", - "entities", - "organization-model-controller" - ] - }, - "get": { - "operationId": "getEntity@LlmEndpoints", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;provider==LLMProviderValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "/api/v1/actions/workspaces/{workspaceId}/translations/set" : { + "post" : { + "description" : "Set translation for existing entities in a particular locale.", + "operationId" : "setTranslations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/xml" : { + "schema" : { + "$ref" : "#/components/schemas/Xliff" + } + } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "Translations were successfully set." + } + }, + "summary" : "Set translations for entities.", + "tags" : [ "Translations", "actions" ], + "x-gdc-security-info" : { + "description" : "Minimal permission required to use this endpoint.", + "permissions" : [ "MANAGE" ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/userGroups" : { + "get" : { + "operationId" : "listWorkspaceUserGroups", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Zero-based page index (0..N)", + "example" : "page=0", + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : 0, + "format" : "int32", + "type" : "integer" + }, + "style" : "form" + }, { + "description" : "The size of the page to be returned.", + "example" : "size=20", + "in" : "query", + "name" : "size", + "required" : false, + "schema" : { + "default" : 20, + "format" : "int32", + "type" : "integer" + }, + "style" : "form" + }, { + "description" : "Filter by user name. Note that user name is case insensitive.", + "example" : "name=charles", + "in" : "query", + "name" : "name", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/WorkspaceUserGroups" + } + } + }, + "description" : "OK" + } + }, + "tags" : [ "User management", "actions" ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/users" : { + "get" : { + "operationId" : "listWorkspaceUsers", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Zero-based page index (0..N)", + "example" : "page=0", + "in" : "query", + "name" : "page", + "required" : false, + "schema" : { + "default" : 0, + "format" : "int32", + "type" : "integer" + }, + "style" : "form" + }, { + "description" : "The size of the page to be returned.", + "example" : "size=20", + "in" : "query", + "name" : "size", + "required" : false, + "schema" : { + "default" : 20, + "format" : "int32", + "type" : "integer" + }, + "style" : "form" + }, { + "description" : "Filter by user name. Note that user name is case insensitive.", + "example" : "name=charles", + "in" : "query", + "name" : "name", + "required" : false, + "schema" : { + "type" : "string" + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/WorkspaceUsers" + } + } + }, + "description" : "OK" + } + }, + "tags" : [ "User management", "actions" ] + } + }, + "/api/v1/entities/admin/cookieSecurityConfigurations/{id}" : { + "get" : { + "operationId" : "getEntity@CookieSecurityConfigurations", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "lastRotation==InstantValue;rotationInterval==DurationValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLlmEndpointOutDocument" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLlmEndpointOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Get LLM endpoint entity", - "tags": [ - "LLM Endpoints", - "entities", - "organization-model-controller" - ] + "summary" : "Get CookieSecurityConfiguration", + "tags" : [ "Cookie Security Configuration", "entities", "organization-controller" ] }, - "patch": { - "operationId": "patchEntity@LlmEndpoints", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;provider==LLMProviderValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "patch" : { + "operationId" : "patchEntity@CookieSecurityConfigurations", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "lastRotation==InstantValue;rotationInterval==DurationValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLlmEndpointPatchDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCookieSecurityConfigurationPatchDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLlmEndpointPatchDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCookieSecurityConfigurationPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLlmEndpointOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLlmEndpointOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch LLM endpoint entity", - "tags": [ - "LLM Endpoints", - "entities", - "organization-model-controller" - ] + "summary" : "Patch CookieSecurityConfiguration", + "tags" : [ "Cookie Security Configuration", "entities", "organization-controller" ] }, - "put": { - "operationId": "updateEntity@LlmEndpoints", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;provider==LLMProviderValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "put" : { + "operationId" : "updateEntity@CookieSecurityConfigurations", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "lastRotation==InstantValue;rotationInterval==DurationValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLlmEndpointInDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCookieSecurityConfigurationInDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLlmEndpointInDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCookieSecurityConfigurationInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLlmEndpointOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLlmEndpointOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "PUT LLM endpoint entity", - "tags": [ - "LLM Endpoints", - "entities", - "organization-model-controller" - ] + "summary" : "Put CookieSecurityConfiguration", + "tags" : [ "Cookie Security Configuration", "entities", "organization-controller" ] } }, - "/api/v1/entities/notificationChannelIdentifiers": { - "get": { - "operationId": "getAllEntities@NotificationChannelIdentifiers", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" + "/api/v1/entities/admin/organizations/{id}" : { + "get" : { + "operationId" : "getEntity@Organizations", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "bootstrapUser,bootstrapUserGroup,identityProvider", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "users", "userGroups", "identityProviders", "bootstrapUser", "bootstrapUserGroup", "identityProvider", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=permissions,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "permissions", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get Organizations", + "tags" : [ "Organization - Entity APIs", "entities", "organization-controller" ], + "x-gdc-security-info" : { + "description" : "Contains permissions required to manipulate the Organization.", + "permissions" : [ "MANAGE" ] + } + }, + "patch" : { + "operationId" : "patchEntity@Organizations", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "bootstrapUser,bootstrapUserGroup,identityProvider", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "users", "userGroups", "identityProviders", "bootstrapUser", "bootstrapUserGroup", "identityProvider", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "$ref": "#/components/parameters/sort" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationPatchDocument" + } + } }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutList" + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "tags": [ - "Notification Channels", - "entities", - "organization-model-controller" - ] - } - }, - "/api/v1/entities/notificationChannelIdentifiers/{id}": { - "get": { - "operationId": "getEntity@NotificationChannelIdentifiers", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "summary" : "Patch Organization", + "tags" : [ "Organization - Entity APIs", "entities", "organization-controller" ], + "x-gdc-security-info" : { + "description" : "Contains permissions required to manipulate the Organization.", + "permissions" : [ "MANAGE" ] + } + }, + "put" : { + "operationId" : "updateEntity@Organizations", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutDocument" + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "bootstrapUser,bootstrapUserGroup,identityProvider", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "users", "userGroups", "identityProviders", "bootstrapUser", "bootstrapUserGroup", "identityProvider", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationInDocument" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "tags": [ - "Notification Channels", - "entities", - "organization-model-controller" - ] + "summary" : "Put Organization", + "tags" : [ "Organization - Entity APIs", "entities", "organization-controller" ], + "x-gdc-security-info" : { + "description" : "Contains permissions required to manipulate the Organization.", + "permissions" : [ "MANAGE" ] + } } }, - "/api/v1/entities/notificationChannels": { - "get": { - "operationId": "getAllEntities@NotificationChannels", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" + "/api/v1/entities/colorPalettes" : { + "get" : { + "operationId" : "getAllEntities@ColorPalettes", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;content==JsonNodeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutList" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiColorPaletteOutList" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiColorPaletteOutList" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Get all Notification Channel entities", - "tags": [ - "Notification Channels", - "entities", - "organization-model-controller" - ] + "summary" : "Get all Color Pallettes", + "tags" : [ "Appearance", "entities", "organization-model-controller" ] }, - "post": { - "operationId": "createEntity@NotificationChannels", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelPostOptionalIdDocument" + "post" : { + "operationId" : "createEntity@ColorPalettes", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiColorPaletteInDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelPostOptionalIdDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiColorPaletteInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiColorPaletteOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiColorPaletteOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post Notification Channel entities", - "tags": [ - "Notification Channels", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "summary" : "Post Color Pallettes", + "tags" : [ "Appearance", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/notificationChannels/{id}": { - "delete": { - "operationId": "deleteEntity@NotificationChannels", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete Notification Channel entity", - "tags": [ - "Notification Channels", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "/api/v1/entities/colorPalettes/{id}" : { + "delete" : { + "operationId" : "deleteEntity@ColorPalettes", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;content==JsonNodeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete a Color Pallette", + "tags" : [ "Appearance", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } }, - "get": { - "operationId": "getEntity@NotificationChannels", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "get" : { + "operationId" : "getEntity@ColorPalettes", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;content==JsonNodeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiColorPaletteOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiColorPaletteOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Get Notification Channel entity", - "tags": [ - "Notification Channels", - "entities", - "organization-model-controller" - ] + "summary" : "Get Color Pallette", + "tags" : [ "Appearance", "entities", "organization-model-controller" ] }, - "patch": { - "operationId": "patchEntity@NotificationChannels", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "patch" : { + "operationId" : "patchEntity@ColorPalettes", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;content==JsonNodeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelPatchDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiColorPalettePatchDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelPatchDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiColorPalettePatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiColorPaletteOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiColorPaletteOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch Notification Channel entity", - "tags": [ - "Notification Channels", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "summary" : "Patch Color Pallette", + "tags" : [ "Appearance", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "operationId": "updateEntity@NotificationChannels", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "put" : { + "operationId" : "updateEntity@ColorPalettes", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;content==JsonNodeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelInDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiColorPaletteInDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelInDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiColorPaletteInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiColorPaletteOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiColorPaletteOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put Notification Channel entity", - "tags": [ - "Notification Channels", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "summary" : "Put Color Pallette", + "tags" : [ "Appearance", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/organization": { - "get": { - "description": "Gets a basic information about organization.", - "operationId": "getOrganization", - "parameters": [ - { - "description": "Return list of permissions available to logged user.", - "example": "metaInclude=permissions", - "explode": false, - "in": "query", - "name": "metaInclude", - "schema": { - "items": { - "description": "Available meta objects to include.", - "enum": [ - "permissions", - "all" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - } + "/api/v1/entities/cspDirectives" : { + "get" : { + "description" : " Context Security Police Directive", + "operationId" : "getAllEntities@CspDirectives", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "sources==v1,v2,v3", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "responses": { - "302": { - "description": "Redirect to entity URI." - } - }, - "summary": "Get current organization info", - "tags": [ - "Organization - Entity APIs", - "entities" - ] - } - }, - "/api/v1/entities/organization/workspaceAutomations": { - "get": { - "operationId": "getAllAutomations@WorkspaceAutomations", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspace.id==321;notificationChannel.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaces", - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "workspace", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Automations across all Workspaces", - "tags": [ - "Automations", - "entities", - "automation-organization-view-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/entities/organizationSettings": { - "get": { - "operationId": "getAllEntities@OrganizationSettings", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCspDirectiveOutList" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCspDirectiveOutList" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Get Organization entities", - "tags": [ - "Organization - Entity APIs", - "entities", - "organization-model-controller" - ] + "summary" : "Get CSP Directives", + "tags" : [ "CSP Directives", "entities", "organization-model-controller" ] }, - "post": { - "operationId": "createEntity@OrganizationSettings", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "post" : { + "description" : " Context Security Police Directive", + "operationId" : "createEntity@CspDirectives", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCspDirectiveInDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCspDirectiveInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCspDirectiveOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCspDirectiveOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post Organization Setting entities", - "tags": [ - "Organization - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "summary" : "Post CSP Directives", + "tags" : [ "CSP Directives", "entities", "organization-model-controller" ] } }, - "/api/v1/entities/organizationSettings/{id}": { - "delete": { - "operationId": "deleteEntity@OrganizationSettings", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "/api/v1/entities/cspDirectives/{id}" : { + "delete" : { + "description" : " Context Security Police Directive", + "operationId" : "deleteEntity@CspDirectives", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "sources==v1,v2,v3", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete Organization entity", - "tags": [ - "Organization - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "get": { - "operationId": "getEntity@OrganizationSettings", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + }, + "summary" : "Delete CSP Directives", + "tags" : [ "CSP Directives", "entities", "organization-model-controller" ] + }, + "get" : { + "description" : " Context Security Police Directive", + "operationId" : "getEntity@CspDirectives", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "sources==v1,v2,v3", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCspDirectiveOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCspDirectiveOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Get Organization entity", - "tags": [ - "Organization - Entity APIs", - "entities", - "organization-model-controller" - ] + "summary" : "Get CSP Directives", + "tags" : [ "CSP Directives", "entities", "organization-model-controller" ] }, - "patch": { - "operationId": "patchEntity@OrganizationSettings", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "patch" : { + "description" : " Context Security Police Directive", + "operationId" : "patchEntity@CspDirectives", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "sources==v1,v2,v3", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCspDirectivePatchDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCspDirectivePatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCspDirectiveOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCspDirectiveOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch Organization entity", - "tags": [ - "Organization - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "summary" : "Patch CSP Directives", + "tags" : [ "CSP Directives", "entities", "organization-model-controller" ] }, - "put": { - "operationId": "updateEntity@OrganizationSettings", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "put" : { + "description" : " Context Security Police Directive", + "operationId" : "updateEntity@CspDirectives", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "sources==v1,v2,v3", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCspDirectiveInDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCspDirectiveInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCspDirectiveOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCspDirectiveOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put Organization entity", - "tags": [ - "Organization - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "summary" : "Put CSP Directives", + "tags" : [ "CSP Directives", "entities", "organization-model-controller" ] } }, - "/api/v1/entities/themes": { - "get": { - "operationId": "getAllEntities@Themes", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;content==JsonNodeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" + "/api/v1/entities/customGeoCollections" : { + "get" : { + "operationId" : "getAllEntities@CustomGeoCollections", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutList" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionOutList" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionOutList" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Get all Theming entities", - "tags": [ - "Appearance", - "entities", - "organization-model-controller" - ] + "tags" : [ "Geographic Data", "entities", "organization-model-controller" ] }, - "post": { - "operationId": "createEntity@Themes", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeInDocument" + "post" : { + "operationId" : "createEntity@CustomGeoCollections", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionInDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeInDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post Theming", - "tags": [ - "Appearance", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "tags" : [ "Geographic Data", "entities", "organization-model-controller" ] } }, - "/api/v1/entities/themes/{id}": { - "delete": { - "operationId": "deleteEntity@Themes", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;content==JsonNodeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "/api/v1/entities/customGeoCollections/{id}" : { + "delete" : { + "operationId" : "deleteEntity@CustomGeoCollections", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete Theming", - "tags": [ - "Appearance", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "tags" : [ "Geographic Data", "entities", "organization-model-controller" ] }, - "get": { - "operationId": "getEntity@Themes", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;content==JsonNodeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "get" : { + "operationId" : "getEntity@CustomGeoCollections", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Get Theming", - "tags": [ - "Appearance", - "entities", - "organization-model-controller" - ] + "tags" : [ "Geographic Data", "entities", "organization-model-controller" ] }, - "patch": { - "operationId": "patchEntity@Themes", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;content==JsonNodeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "patch" : { + "operationId" : "patchEntity@CustomGeoCollections", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemePatchDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionPatchDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemePatchDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch Theming", - "tags": [ - "Appearance", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "tags" : [ "Geographic Data", "entities", "organization-model-controller" ] }, - "put": { - "operationId": "updateEntity@Themes", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;content==JsonNodeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "put" : { + "operationId" : "updateEntity@CustomGeoCollections", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeInDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionInDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeInDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put Theming", - "tags": [ - "Appearance", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "tags" : [ "Geographic Data", "entities", "organization-model-controller" ] + } + }, + "/api/v1/entities/dataSourceIdentifiers" : { + "get" : { + "operationId" : "getAllEntities@DataSourceIdentifiers", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;schema==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=permissions,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "permissions", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceIdentifierOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceIdentifierOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Data Source Identifiers", + "tags" : [ "Data Source - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "USE" ] } } }, - "/api/v1/entities/userGroups": { - "get": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "getAllEntities@UserGroups", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "parents", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userGroups", - "parents", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get UserGroup entities", - "tags": [ - "UserGroups - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "MANAGE" - ] + "/api/v1/entities/dataSourceIdentifiers/{id}" : { + "get" : { + "operationId" : "getEntity@DataSourceIdentifiers", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;schema==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=permissions,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "permissions", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceIdentifierOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceIdentifierOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get Data Source Identifier", + "tags" : [ "Data Source - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "USE" ] + } + } + }, + "/api/v1/entities/dataSources" : { + "get" : { + "description" : "Data Source - represents data source for the workspace", + "operationId" : "getAllEntities@DataSources", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;type==DatabaseTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=permissions,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "permissions", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get Data Source entities", + "tags" : [ "Data Source - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "MANAGE" ] } }, - "post": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "createEntity@UserGroups", - "parameters": [ - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "parents", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userGroups", - "parents", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupInDocument" + "post" : { + "description" : "Data Source - represents data source for the workspace", + "operationId" : "createEntity@DataSources", + "parameters" : [ { + "description" : "Include Meta objects.", + "example" : "metaInclude=permissions,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "permissions", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post User Group entities", - "tags": [ - "UserGroups - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "summary" : "Post Data Sources", + "tags" : [ "Data Source - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/userGroups/{id}": { - "delete": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "deleteEntity@UserGroups", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete UserGroup entity", - "tags": [ - "UserGroups - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "/api/v1/entities/dataSources/{id}" : { + "delete" : { + "description" : "Data Source - represents data source for the workspace", + "operationId" : "deleteEntity@DataSources", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;type==DatabaseTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete Data Source entity", + "tags" : [ "Data Source - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } }, - "get": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "getEntity@UserGroups", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "parents", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userGroups", - "parents", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get UserGroup entity", - "tags": [ - "UserGroups - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "MANAGE" - ] + "get" : { + "description" : "Data Source - represents data source for the workspace", + "operationId" : "getEntity@DataSources", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;type==DatabaseTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=permissions,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "permissions", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get Data Source entity", + "tags" : [ "Data Source - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "MANAGE" ] } }, - "patch": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "patchEntity@UserGroups", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "parents", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userGroups", - "parents", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupPatchDocument" + "patch" : { + "description" : "Data Source - represents data source for the workspace", + "operationId" : "patchEntity@DataSources", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;type==DatabaseTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourcePatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourcePatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch UserGroup entity", - "tags": [ - "UserGroups - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "summary" : "Patch Data Source entity", + "tags" : [ "Data Source - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "updateEntity@UserGroups", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "parents", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userGroups", - "parents", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupInDocument" + "put" : { + "description" : "Data Source - represents data source for the workspace", + "operationId" : "updateEntity@DataSources", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;type==DatabaseTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDataSourceOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put UserGroup entity", - "tags": [ - "UserGroups - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "summary" : "Put Data Source entity", + "tags" : [ "Data Source - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/userIdentifiers": { - "get": { - "description": "UserIdentifier - represents entity interacting with platform", - "operationId": "getAllEntities@UserIdentifiers", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "firstname==someString;lastname==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" + "/api/v1/entities/entitlements" : { + "get" : { + "description" : "Space of the shared interest", + "operationId" : "getAllEntities@Entitlements", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "value==someString;expiry==LocalDateValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiEntitlementOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiEntitlementOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get Entitlements", + "tags" : [ "Entitlement", "entities", "organization-model-controller" ] + } + }, + "/api/v1/entities/entitlements/{id}" : { + "get" : { + "description" : "Space of the shared interest", + "operationId" : "getEntity@Entitlements", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "value==someString;expiry==LocalDateValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutList" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiEntitlementOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiEntitlementOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Get UserIdentifier entities", - "tags": [ - "User Identifiers", - "entities", - "organization-model-controller" - ] + "summary" : "Get Entitlement", + "tags" : [ "Entitlement", "entities", "organization-model-controller" ] } }, - "/api/v1/entities/userIdentifiers/{id}": { - "get": { - "description": "UserIdentifier - represents basic information about entity interacting with platform", - "operationId": "getEntity@UserIdentifiers", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "firstname==someString;lastname==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "/api/v1/entities/exportTemplates" : { + "get" : { + "operationId" : "getAllEntities@ExportTemplates", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutDocument" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportTemplateOutList" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportTemplateOutList" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Get UserIdentifier entity", - "tags": [ - "User Identifiers", - "entities", - "organization-model-controller" - ] - } - }, - "/api/v1/entities/users": { - "get": { - "description": "User - represents entity interacting with platform", - "operationId": "getAllEntities@Users", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "authenticationId==someString;firstname==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userGroups", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get User entities", - "tags": [ - "Users - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "MANAGE" - ] - } + "summary" : "GET all Export Template entities", + "tags" : [ "Export templates", "entities", "organization-model-controller" ] }, - "post": { - "description": "User - represents entity interacting with platform", - "operationId": "createEntity@Users", - "parameters": [ - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userGroups", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserInDocument" + "post" : { + "operationId" : "createEntity@ExportTemplates", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportTemplatePostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportTemplatePostOptionalIdDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportTemplateOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportTemplateOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post User entities", - "tags": [ - "Users - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "summary" : "Post Export Template entities", + "tags" : [ "Export templates", "entities", "organization-model-controller" ] } }, - "/api/v1/entities/users/{id}": { - "delete": { - "description": "User - represents entity interacting with platform", - "operationId": "deleteEntity@Users", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "authenticationId==someString;firstname==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "/api/v1/entities/exportTemplates/{id}" : { + "delete" : { + "operationId" : "deleteEntity@ExportTemplates", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete User entity", - "tags": [ - "Users - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "get": { - "description": "User - represents entity interacting with platform", - "operationId": "getEntity@Users", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "authenticationId==someString;firstname==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userGroups", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get User entity", - "tags": [ - "Users - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "patch": { - "description": "User - represents entity interacting with platform", - "operationId": "patchEntity@Users", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "authenticationId==someString;firstname==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userGroups", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserPatchDocument" - } - } - }, - "required": true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "summary" : "Delete Export Template entity", + "tags" : [ "Export templates", "entities", "organization-model-controller" ] + }, + "get" : { + "operationId" : "getEntity@ExportTemplates", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportTemplateOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportTemplateOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch User entity", - "tags": [ - "Users - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "summary" : "GET Export Template entity", + "tags" : [ "Export templates", "entities", "organization-model-controller" ] }, - "put": { - "description": "User - represents entity interacting with platform", - "operationId": "updateEntity@Users", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "authenticationId==someString;firstname==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userGroups", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserInDocument" + "patch" : { + "operationId" : "patchEntity@ExportTemplates", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportTemplatePatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportTemplatePatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportTemplateOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportTemplateOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put User entity", - "tags": [ - "Users - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/entities/users/{userId}/apiTokens": { - "get": { - "operationId": "getAllEntities@ApiTokens", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "bearerToken==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "List all api tokens for a user", - "tags": [ - "API tokens", - "entities", - "user-model-controller" - ] - }, - "post": { - "operationId": "createEntity@ApiTokens", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } + "summary" : "Patch Export Template entity", + "tags" : [ "Export templates", "entities", "organization-model-controller" ] + }, + "put" : { + "operationId" : "updateEntity@ExportTemplates", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenInDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportTemplateInDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenInDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportTemplateInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportTemplateOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportTemplateOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post a new API token for the user", - "tags": [ - "API tokens", - "entities", - "user-model-controller" - ] + "summary" : "PUT Export Template entity", + "tags" : [ "Export templates", "entities", "organization-model-controller" ] } }, - "/api/v1/entities/users/{userId}/apiTokens/{id}": { - "delete": { - "operationId": "deleteEntity@ApiTokens", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "bearerToken==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "/api/v1/entities/identityProviders" : { + "get" : { + "operationId" : "getAllEntities@IdentityProviders", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "identifiers==v1,v2,v3;customClaimMapping==MapValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete an API Token for a user", - "tags": [ - "API tokens", - "entities", - "user-model-controller" - ] - }, - "get": { - "operationId": "getEntity@ApiTokens", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/idPathParameter" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "bearerToken==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderOutList" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderOutList" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Get an API Token for a user", - "tags": [ - "API tokens", - "entities", - "user-model-controller" - ] - } - }, - "/api/v1/entities/users/{userId}/userSettings": { - "get": { - "operationId": "getAllEntities@UserSettings", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "List all settings for a user", - "tags": [ - "User Settings", - "entities", - "user-model-controller" - ] - }, - "post": { - "operationId": "createEntity@UserSettings", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingInDocument" + "summary" : "Get all Identity Providers", + "tags" : [ "Identity Providers", "entities", "organization-model-controller" ] + }, + "post" : { + "operationId" : "createEntity@IdentityProviders", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderInDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingInDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post new user settings for the user", - "tags": [ - "User Settings", - "entities", - "user-model-controller" - ] + "summary" : "Post Identity Providers", + "tags" : [ "Identity Providers", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] + } } }, - "/api/v1/entities/users/{userId}/userSettings/{id}": { - "delete": { - "operationId": "deleteEntity@UserSettings", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete a setting for a user", - "tags": [ - "User Settings", - "entities", - "user-model-controller" - ] - }, - "get": { - "operationId": "getEntity@UserSettings", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "/api/v1/entities/identityProviders/{id}" : { + "delete" : { + "operationId" : "deleteEntity@IdentityProviders", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "identifiers==v1,v2,v3;customClaimMapping==MapValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete Identity Provider", + "tags" : [ "Identity Providers", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] + } + }, + "get" : { + "operationId" : "getEntity@IdentityProviders", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "identifiers==v1,v2,v3;customClaimMapping==MapValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Get a setting for a user", - "tags": [ - "User Settings", - "entities", - "user-model-controller" - ] + "summary" : "Get Identity Provider", + "tags" : [ "Identity Providers", "entities", "organization-model-controller" ] }, - "put": { - "operationId": "updateEntity@UserSettings", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "patch" : { + "operationId" : "patchEntity@IdentityProviders", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "identifiers==v1,v2,v3;customClaimMapping==MapValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingInDocument" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderPatchDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingInDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put new user settings for the user", - "tags": [ - "User Settings", - "entities", - "user-model-controller" - ] - } - }, - "/api/v1/entities/workspaces": { - "get": { - "description": "Space of the shared interest", - "operationId": "getAllEntities@Workspaces", - "parameters": [ - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;earlyAccess==someString;parent.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "parent", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaces", - "parent", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "config", - "permissions", - "hierarchy", - "dataModelDatasets", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get Workspace entities", - "tags": [ - "Workspaces - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "summary" : "Patch Identity Provider", + "tags" : [ "Identity Providers", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } }, - "post": { - "description": "Space of the shared interest", - "operationId": "createEntity@Workspaces", - "parameters": [ - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "parent", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaces", - "parent", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "config", - "permissions", - "hierarchy", - "dataModelDatasets", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" + "put" : { + "operationId" : "updateEntity@IdentityProviders", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "identifiers==v1,v2,v3;customClaimMapping==MapValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiIdentityProviderOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post Workspace entities", - "tags": [ - "Workspaces - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "summary" : "Put Identity Provider", + "tags" : [ "Identity Providers", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{id}": { - "delete": { - "description": "Space of the shared interest", - "operationId": "deleteEntity@Workspaces", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;earlyAccess==someString;parent.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "/api/v1/entities/jwks" : { + "get" : { + "description" : "Returns all JSON web keys - used to verify JSON web tokens (Jwts)", + "operationId" : "getAllEntities@Jwks", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JwkSpecificationValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete Workspace entity", - "tags": [ - "Workspaces - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "get": { - "description": "Space of the shared interest", - "operationId": "getEntity@Workspaces", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;earlyAccess==someString;parent.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "parent", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaces", - "parent", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "config", - "permissions", - "hierarchy", - "dataModelDatasets", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get Workspace entity", - "tags": [ - "Workspaces - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - }, - "patch": { - "description": "Space of the shared interest", - "operationId": "patchEntity@Workspaces", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;earlyAccess==someString;parent.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "parent", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaces", - "parent", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" - } - } + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiJwkOutList" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiJwkOutList" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch Workspace entity", - "tags": [ - "Workspaces - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "summary" : "Get all Jwks", + "tags" : [ "JWKS", "entities", "organization-model-controller" ] }, - "put": { - "description": "Space of the shared interest", - "operationId": "updateEntity@Workspaces", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;earlyAccess==someString;parent.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "parent", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaces", - "parent", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" + "post" : { + "description" : "Creates JSON web key - used to verify JSON web tokens (Jwts)", + "operationId" : "createEntity@Jwks", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiJwkInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiJwkInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiJwkOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiJwkOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put Workspace entity", - "tags": [ - "Workspaces - Entity APIs", - "entities", - "organization-model-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "summary" : "Post Jwks", + "tags" : [ "JWKS", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts": { - "get": { - "operationId": "getAllEntities@AggregatedFacts", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "dataset,sourceFact", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "datasets", - "facts", - "dataset", - "sourceFact", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" + "/api/v1/entities/jwks/{id}" : { + "delete" : { + "description" : "Deletes JSON web key - used to verify JSON web tokens (Jwts)", + "operationId" : "deleteEntity@Jwks", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JwkSpecificationValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete Jwk", + "tags" : [ "JWKS", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] + } + }, + "get" : { + "description" : "Returns JSON web key - used to verify JSON web tokens (Jwts)", + "operationId" : "getEntity@Jwks", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JwkSpecificationValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiJwkOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiJwkOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "tags": [ - "Facts", - "entities", - "workspace-object-controller" - ] - } - }, - "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search": { - "post": { - "operationId": "searchEntities@AggregatedFacts", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "summary" : "Get Jwk", + "tags" : [ "JWKS", "entities", "organization-model-controller" ] + }, + "patch" : { + "description" : "Patches JSON web key - used to verify JSON web tokens (Jwts)", + "operationId" : "patchEntity@Jwks", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JwkSpecificationValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" - } - } - }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" - } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiJwkPatchDocument" } }, - "description": "Request successfully processed" - } - }, - "summary": "Search request for AggregatedFact", - "tags": [ - "Facts", - "entities", - "workspace-object-controller" - ] - } - }, - "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId}": { - "get": { - "operationId": "getEntity@AggregatedFacts", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "dataset,sourceFact", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "datasets", - "facts", - "dataset", - "sourceFact", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiJwkPatchDocument" + } } }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiJwkOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiJwkOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "tags": [ - "Facts", - "entities", - "workspace-object-controller" - ] - } - }, - "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards": { - "get": { - "operationId": "getAllEntities@AnalyticalDashboards", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", - "labels", - "metrics", - "datasets", - "filterContexts", - "dashboardPlugins", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,accessInfo,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "origin", - "accessInfo", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Dashboards", - "tags": [ - "Dashboards", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "summary" : "Patch Jwk", + "tags" : [ "JWKS", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } }, - "post": { - "operationId": "createEntity@AnalyticalDashboards", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", - "labels", - "metrics", - "datasets", - "filterContexts", - "dashboardPlugins", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,accessInfo,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "origin", - "accessInfo", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" + "put" : { + "description" : "Updates JSON web key - used to verify JSON web tokens (Jwts)", + "operationId" : "updateEntity@Jwks", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JwkSpecificationValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiJwkInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiJwkInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiJwkOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiJwkOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post Dashboards", - "tags": [ - "Dashboards", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] + "summary" : "Put Jwk", + "tags" : [ "JWKS", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search": { - "post": { - "operationId": "searchEntities@AnalyticalDashboards", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } + "/api/v1/entities/llmEndpoints" : { + "get" : { + "operationId" : "getAllEntities@LlmEndpoints", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;provider==LLMProviderValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointOutList" + } + } + }, + "description" : "Request successfully processed" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + }, + "summary" : "Get all LLM endpoint entities", + "tags" : [ "LLM Endpoints", "entities", "organization-model-controller" ] + }, + "post" : { + "operationId" : "createEntity@LlmEndpoints", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointInDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for AnalyticalDashboard", - "tags": [ - "Dashboards", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "summary" : "Post LLM endpoint entities", + "tags" : [ "LLM Endpoints", "entities", "organization-model-controller" ] } }, - "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}": { - "delete": { - "operationId": "deleteEntity@AnalyticalDashboards", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "/api/v1/entities/llmEndpoints/{id}" : { + "delete" : { + "operationId" : "deleteEntity@LlmEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;provider==LLMProviderValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete a Dashboard", - "tags": [ - "Dashboards", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "tags" : [ "LLM Endpoints", "entities", "organization-model-controller" ] }, - "get": { - "operationId": "getEntity@AnalyticalDashboards", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", - "labels", - "metrics", - "datasets", - "filterContexts", - "dashboardPlugins", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,accessInfo,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "origin", - "accessInfo", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get a Dashboard", - "tags": [ - "Dashboards", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "get" : { + "operationId" : "getEntity@LlmEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;provider==LLMProviderValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get LLM endpoint entity", + "tags" : [ "LLM Endpoints", "entities", "organization-model-controller" ] }, - "patch": { - "operationId": "patchEntity@AnalyticalDashboards", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", - "labels", - "metrics", - "datasets", - "filterContexts", - "dashboardPlugins", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" + "patch" : { + "operationId" : "patchEntity@LlmEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;provider==LLMProviderValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch a Dashboard", - "tags": [ - "Dashboards", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } + "summary" : "Patch LLM endpoint entity", + "tags" : [ "LLM Endpoints", "entities", "organization-model-controller" ] }, - "put": { - "operationId": "updateEntity@AnalyticalDashboards", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", - "labels", - "metrics", - "datasets", - "filterContexts", - "dashboardPlugins", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" + "put" : { + "operationId" : "updateEntity@LlmEndpoints", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;provider==LLMProviderValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLlmEndpointOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put Dashboards", - "tags": [ - "Dashboards", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } + "summary" : "PUT LLM endpoint entity", + "tags" : [ "LLM Endpoints", "entities", "organization-model-controller" ] } }, - "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies": { - "get": { - "operationId": "getAllEntities@AttributeHierarchies", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,attributes", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "attributes", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Attribute Hierarchies", - "tags": [ - "Attribute Hierarchies", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - }, - "post": { - "operationId": "createEntity@AttributeHierarchies", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,attributes", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "attributes", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "/api/v1/entities/notificationChannelIdentifiers" : { + "get" : { + "operationId" : "getAllEntities@NotificationChannelIdentifiers", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelIdentifierOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelIdentifierOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "tags" : [ "Notification Channels", "entities", "organization-model-controller" ] + } + }, + "/api/v1/entities/notificationChannelIdentifiers/{id}" : { + "get" : { + "operationId" : "getEntity@NotificationChannelIdentifiers", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelIdentifierOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelIdentifierOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post Attribute Hierarchies", - "tags": [ - "Attribute Hierarchies", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } + "tags" : [ "Notification Channels", "entities", "organization-model-controller" ] } }, - "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search": { - "post": { - "operationId": "searchEntities@AttributeHierarchies", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } + "/api/v1/entities/notificationChannels" : { + "get" : { + "operationId" : "getAllEntities@NotificationChannels", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelOutList" + } + } + }, + "description" : "Request successfully processed" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + }, + "summary" : "Get all Notification Channel entities", + "tags" : [ "Notification Channels", "entities", "organization-model-controller" ] + }, + "post" : { + "operationId" : "createEntity@NotificationChannels", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelPostOptionalIdDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for AttributeHierarchy", - "tags": [ - "Attribute Hierarchies", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "summary" : "Post Notification Channel entities", + "tags" : [ "Notification Channels", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}": { - "delete": { - "operationId": "deleteEntity@AttributeHierarchies", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete an Attribute Hierarchy", - "tags": [ - "Attribute Hierarchies", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] + "/api/v1/entities/notificationChannels/{id}" : { + "delete" : { + "operationId" : "deleteEntity@NotificationChannels", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete Notification Channel entity", + "tags" : [ "Notification Channels", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } }, - "get": { - "operationId": "getEntity@AttributeHierarchies", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,attributes", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "attributes", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get an Attribute Hierarchy", - "tags": [ - "Attribute Hierarchies", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "get" : { + "operationId" : "getEntity@NotificationChannels", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get Notification Channel entity", + "tags" : [ "Notification Channels", "entities", "organization-model-controller" ] }, - "patch": { - "operationId": "patchEntity@AttributeHierarchies", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,attributes", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "attributes", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" + "patch" : { + "operationId" : "patchEntity@NotificationChannels", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch an Attribute Hierarchy", - "tags": [ - "Attribute Hierarchies", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] + "summary" : "Patch Notification Channel entity", + "tags" : [ "Notification Channels", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "operationId": "updateEntity@AttributeHierarchies", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,attributes", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "attributes", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + "put" : { + "operationId" : "updateEntity@NotificationChannels", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiNotificationChannelOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put an Attribute Hierarchy", - "tags": [ - "Attribute Hierarchies", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] + "summary" : "Put Notification Channel entity", + "tags" : [ "Notification Channels", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributes": { - "get": { - "operationId": "getAllEntities@Attributes", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;dataset.id==321;defaultView.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "dataset,defaultView,labels,attributeHierarchies", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "datasets", - "labels", - "attributeHierarchies", - "dataset", - "defaultView", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Attributes", - "tags": [ - "Attributes", - "entities", - "workspace-object-controller" - ] + "/api/v1/entities/organization" : { + "get" : { + "description" : "Gets a basic information about organization.", + "operationId" : "getOrganization", + "parameters" : [ { + "description" : "Return list of permissions available to logged user.", + "example" : "metaInclude=permissions", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "schema" : { + "items" : { + "description" : "Available meta objects to include.", + "enum" : [ "permissions", "all" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + } + } ], + "responses" : { + "302" : { + "description" : "Redirect to entity URI." + } + }, + "summary" : "Get current organization info", + "tags" : [ "Organization - Entity APIs", "entities" ] } }, - "/api/v1/entities/workspaces/{workspaceId}/attributes/search": { - "post": { - "operationId": "searchEntities@Attributes", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "/api/v1/entities/organization/workspaceAutomations" : { + "get" : { + "operationId" : "getAllAutomations@WorkspaceAutomations", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;workspace.id==321;notificationChannel.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "workspaces", "notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "workspace", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceAutomationOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceAutomationOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Automations across all Workspaces", + "tags" : [ "Automations", "entities", "automation-organization-view-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "MANAGE" ] + } + } + }, + "/api/v1/entities/organizationSettings" : { + "get" : { + "operationId" : "getAllEntities@OrganizationSettings", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JsonNodeValue;type==SettingTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" - } - } + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingOutList" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingOutList" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for Attribute", - "tags": [ - "Attributes", - "entities", - "workspace-object-controller" - ] - } - }, - "/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}": { - "get": { - "operationId": "getEntity@Attributes", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;dataset.id==321;defaultView.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "dataset,defaultView,labels,attributeHierarchies", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "datasets", - "labels", - "attributeHierarchies", - "dataset", - "defaultView", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get an Attribute", - "tags": [ - "Attributes", - "entities", - "workspace-object-controller" - ] - }, - "patch": { - "operationId": "patchEntity@Attributes", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;dataset.id==321;defaultView.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "dataset,defaultView,labels,attributeHierarchies", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "datasets", - "labels", - "attributeHierarchies", - "dataset", - "defaultView", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributePatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributePatchDocument" + "summary" : "Get Organization entities", + "tags" : [ "Organization - Entity APIs", "entities", "organization-model-controller" ] + }, + "post" : { + "operationId" : "createEntity@OrganizationSettings", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch an Attribute (beta)", - "tags": [ - "Attributes", - "entities", - "workspace-object-controller" - ] + "summary" : "Post Organization Setting entities", + "tags" : [ "Organization - Entity APIs", "entities", "organization-model-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": { - "post": { - "operationId": "searchEntities@AutomationResults", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "/api/v1/entities/organizationSettings/{id}" : { + "delete" : { + "operationId" : "deleteEntity@OrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JsonNodeValue;type==SettingTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete Organization entity", + "tags" : [ "Organization - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] + } + }, + "get" : { + "operationId" : "getEntity@OrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JsonNodeValue;type==SettingTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" - } - } - }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationResultOutList" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationResultOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for AutomationResult", - "tags": [ - "Automations", - "entities", - "workspace-object-controller" - ] - } - }, - "/api/v1/entities/workspaces/{workspaceId}/automations": { - "get": { - "operationId": "getAllEntities@Automations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Automations", - "tags": [ - "Automations", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "summary" : "Get Organization entity", + "tags" : [ "Organization - Entity APIs", "entities", "organization-model-controller" ] }, - "post": { - "operationId": "createEntity@Automations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" + "patch" : { + "operationId" : "patchEntity@OrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JsonNodeValue;type==SettingTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post Automations", - "tags": [ - "Automations", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "CREATE_AUTOMATION" - ] + "summary" : "Patch Organization entity", + "tags" : [ "Organization - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/automations/search": { - "post": { - "operationId": "searchEntities@Automations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + }, + "put" : { + "operationId" : "updateEntity@OrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JsonNodeValue;type==SettingTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingInDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiOrganizationSettingOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for Automation", - "tags": [ - "Automations", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "summary" : "Put Organization entity", + "tags" : [ "Organization - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}": { - "delete": { - "operationId": "deleteEntity@Automations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete an Automation", - "tags": [ - "Automations", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "CREATE_AUTOMATION" - ] - } - }, - "get": { - "operationId": "getEntity@Automations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get an Automation", - "tags": [ - "Automations", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - }, - "patch": { - "operationId": "patchEntity@Automations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" - } - } + "/api/v1/entities/themes" : { + "get" : { + "operationId" : "getAllEntities@Themes", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;content==JsonNodeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiThemeOutList" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiThemeOutList" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch an Automation", - "tags": [ - "Automations", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "CREATE_AUTOMATION" - ] - } + "summary" : "Get all Theming entities", + "tags" : [ "Appearance", "entities", "organization-model-controller" ] }, - "put": { - "operationId": "updateEntity@Automations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" + "post" : { + "operationId" : "createEntity@Themes", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiThemeInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiThemeInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiThemeOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiThemeOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put an Automation", - "tags": [ - "Automations", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "CREATE_AUTOMATION" - ] + "summary" : "Post Theming", + "tags" : [ "Appearance", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings": { - "get": { - "operationId": "getAllEntities@CustomApplicationSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "applicationName==someString;content==JsonNodeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Custom Application Settings", - "tags": [ - "Workspaces - Settings", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "/api/v1/entities/themes/{id}" : { + "delete" : { + "operationId" : "deleteEntity@Themes", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;content==JsonNodeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete Theming", + "tags" : [ "Appearance", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } }, - "post": { - "operationId": "createEntity@CustomApplicationSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" + "get" : { + "operationId" : "getEntity@Themes", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;content==JsonNodeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiThemeOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiThemeOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get Theming", + "tags" : [ "Appearance", "entities", "organization-model-controller" ] + }, + "patch" : { + "operationId" : "patchEntity@Themes", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;content==JsonNodeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiThemePatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiThemePatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiThemeOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiThemeOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post Custom Application Settings", - "tags": [ - "Workspaces - Settings", - "entities", - "workspace-object-controller" - ] - } - }, - "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search": { - "post": { - "operationId": "searchEntities@CustomApplicationSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "summary" : "Patch Theming", + "tags" : [ "Appearance", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] + } + }, + "put" : { + "operationId" : "updateEntity@Themes", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;content==JsonNodeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiThemeInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiThemeInDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiThemeOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiThemeOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for CustomApplicationSetting", - "tags": [ - "Workspaces - Settings", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "summary" : "Put Theming", + "tags" : [ "Appearance", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}": { - "delete": { - "operationId": "deleteEntity@CustomApplicationSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "applicationName==someString;content==JsonNodeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete a Custom Application Setting", - "tags": [ - "Workspaces - Settings", - "entities", - "workspace-object-controller" - ] - }, - "get": { - "operationId": "getEntity@CustomApplicationSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "applicationName==someString;content==JsonNodeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get a Custom Application Setting", - "tags": [ - "Workspaces - Settings", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "/api/v1/entities/userGroups" : { + "get" : { + "description" : "User Group - creates tree-like structure for categorizing users", + "operationId" : "getAllEntities@UserGroups", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "parents", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userGroups", "parents", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserGroupOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserGroupOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get UserGroup entities", + "tags" : [ "UserGroups - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "MANAGE" ] } }, - "patch": { - "operationId": "patchEntity@CustomApplicationSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } + "post" : { + "description" : "User Group - creates tree-like structure for categorizing users", + "operationId" : "createEntity@UserGroups", + "parameters" : [ { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "parents", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userGroups", "parents", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "applicationName==someString;content==JsonNodeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserGroupInDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserGroupInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserGroupOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserGroupOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch a Custom Application Setting", - "tags": [ - "Workspaces - Settings", - "entities", - "workspace-object-controller" - ] + "summary" : "Post User Group entities", + "tags" : [ "UserGroups - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] + } + } + }, + "/api/v1/entities/userGroups/{id}" : { + "delete" : { + "description" : "User Group - creates tree-like structure for categorizing users", + "operationId" : "deleteEntity@UserGroups", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete UserGroup entity", + "tags" : [ "UserGroups - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] + } }, - "put": { - "operationId": "updateEntity@CustomApplicationSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "applicationName==someString;content==JsonNodeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "get" : { + "description" : "User Group - creates tree-like structure for categorizing users", + "operationId" : "getEntity@UserGroups", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "parents", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userGroups", "parents", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserGroupOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserGroupOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get UserGroup entity", + "tags" : [ "UserGroups - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "MANAGE" ] + } + }, + "patch" : { + "description" : "User Group - creates tree-like structure for categorizing users", + "operationId" : "patchEntity@UserGroups", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "parents", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userGroups", "parents", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserGroupPatchDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserGroupPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserGroupOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserGroupOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put a Custom Application Setting", - "tags": [ - "Workspaces - Settings", - "entities", - "workspace-object-controller" - ] - } - }, - "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins": { - "get": { - "operationId": "getAllEntities@DashboardPlugins", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Plugins", - "tags": [ - "Plugins", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "summary" : "Patch UserGroup entity", + "tags" : [ "UserGroups - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } }, - "post": { - "operationId": "createEntity@DashboardPlugins", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "put" : { + "description" : "User Group - creates tree-like structure for categorizing users", + "operationId" : "updateEntity@UserGroups", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "parents", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userGroups", "parents", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserGroupInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserGroupInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserGroupOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserGroupOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post Plugins", - "tags": [ - "Plugins", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] + "summary" : "Put UserGroup entity", + "tags" : [ "UserGroups - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search": { - "post": { - "operationId": "searchEntities@DashboardPlugins", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "/api/v1/entities/userIdentifiers" : { + "get" : { + "description" : "UserIdentifier - represents entity interacting with platform", + "operationId" : "getAllEntities@UserIdentifiers", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "firstname==someString;lastname==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get UserIdentifier entities", + "tags" : [ "User Identifiers", "entities", "organization-model-controller" ] + } + }, + "/api/v1/entities/userIdentifiers/{id}" : { + "get" : { + "description" : "UserIdentifier - represents basic information about entity interacting with platform", + "operationId" : "getEntity@UserIdentifiers", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "firstname==someString;lastname==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserIdentifierOutDocument" + } + } + }, + "description" : "Request successfully processed" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + }, + "summary" : "Get UserIdentifier entity", + "tags" : [ "User Identifiers", "entities", "organization-model-controller" ] + } + }, + "/api/v1/entities/users" : { + "get" : { + "description" : "User - represents entity interacting with platform", + "operationId" : "getAllEntities@Users", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "authenticationId==someString;firstname==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "userGroups", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userGroups", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get User entities", + "tags" : [ "Users - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "MANAGE" ] + } + }, + "post" : { + "description" : "User - represents entity interacting with platform", + "operationId" : "createEntity@Users", + "parameters" : [ { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "userGroups", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userGroups", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserInDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for DashboardPlugin", - "tags": [ - "Plugins", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "summary" : "Post User entities", + "tags" : [ "Users - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}": { - "delete": { - "operationId": "deleteEntity@DashboardPlugins", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete a Plugin", - "tags": [ - "Plugins", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] + "/api/v1/entities/users/{id}" : { + "delete" : { + "description" : "User - represents entity interacting with platform", + "operationId" : "deleteEntity@Users", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "authenticationId==someString;firstname==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete User entity", + "tags" : [ "Users - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } }, - "get": { - "operationId": "getEntity@DashboardPlugins", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get a Plugin", - "tags": [ - "Plugins", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "get" : { + "description" : "User - represents entity interacting with platform", + "operationId" : "getEntity@Users", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "authenticationId==someString;firstname==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "userGroups", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userGroups", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get User entity", + "tags" : [ "Users - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "MANAGE" ] } }, - "patch": { - "operationId": "patchEntity@DashboardPlugins", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "patch" : { + "description" : "User - represents entity interacting with platform", + "operationId" : "patchEntity@Users", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "authenticationId==someString;firstname==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "userGroups", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userGroups", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch a Plugin", - "tags": [ - "Plugins", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] + "summary" : "Patch User entity", + "tags" : [ "Users - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "operationId": "updateEntity@DashboardPlugins", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "put" : { + "description" : "User - represents entity interacting with platform", + "operationId" : "updateEntity@Users", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "authenticationId==someString;firstname==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "userGroups", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userGroups", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put a Plugin", - "tags": [ - "Plugins", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] + "summary" : "Put User entity", + "tags" : [ "Users - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/datasets": { - "get": { - "operationId": "getAllEntities@Datasets", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "attributes", - "facts", - "aggregatedFacts", - "datasets", - "workspaceDataFilters", - "references", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Datasets", - "tags": [ - "Datasets", - "entities", - "workspace-object-controller" - ] - } - }, - "/api/v1/entities/workspaces/{workspaceId}/datasets/search": { - "post": { - "operationId": "searchEntities@Datasets", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "/api/v1/entities/users/{userId}/apiTokens" : { + "get" : { + "operationId" : "getAllEntities@ApiTokens", + "parameters" : [ { + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" - } - } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "bearerToken==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiApiTokenOutList" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiApiTokenOutList" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for Dataset", - "tags": [ - "Datasets", - "entities", - "workspace-object-controller" - ] - } - }, - "/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}": { - "get": { - "operationId": "getEntity@Datasets", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "attributes", - "facts", - "aggregatedFacts", - "datasets", - "workspaceDataFilters", - "references", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get a Dataset", - "tags": [ - "Datasets", - "entities", - "workspace-object-controller" - ] - }, - "patch": { - "operationId": "patchEntity@Datasets", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "attributes", - "facts", - "aggregatedFacts", - "datasets", - "workspaceDataFilters", - "references", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" + "summary" : "List all api tokens for a user", + "tags" : [ "API tokens", "entities", "user-model-controller" ] + }, + "post" : { + "operationId" : "createEntity@ApiTokens", + "parameters" : [ { + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiApiTokenInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiApiTokenInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiApiTokenOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiApiTokenOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch a Dataset (beta)", - "tags": [ - "Datasets", - "entities", - "workspace-object-controller" - ] + "summary" : "Post a new API token for the user", + "tags" : [ "API tokens", "entities", "user-model-controller" ] } }, - "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions": { - "get": { - "operationId": "getAllEntities@ExportDefinitions", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "visualizationObjects", - "analyticalDashboards", - "automations", - "userIdentifiers", - "visualizationObject", - "analyticalDashboard", - "automation", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Export Definitions", - "tags": [ - "Export Definitions", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - }, - "post": { - "operationId": "createEntity@ExportDefinitions", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "visualizationObjects", - "analyticalDashboards", - "automations", - "userIdentifiers", - "visualizationObject", - "analyticalDashboard", - "automation", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionPostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionPostOptionalIdDocument" - } - } + "/api/v1/entities/users/{userId}/apiTokens/{id}" : { + "delete" : { + "operationId" : "deleteEntity@ApiTokens", + "parameters" : [ { + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "bearerToken==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete an API Token for a user", + "tags" : [ "API tokens", "entities", "user-model-controller" ] + }, + "get" : { + "operationId" : "getEntity@ApiTokens", + "parameters" : [ { + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "bearerToken==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiApiTokenOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiApiTokenOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get an API Token for a user", + "tags" : [ "API tokens", "entities", "user-model-controller" ] + } + }, + "/api/v1/entities/users/{userId}/userSettings" : { + "get" : { + "operationId" : "getAllEntities@UserSettings", + "parameters" : [ { + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JsonNodeValue;type==SettingTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserSettingOutList" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserSettingOutList" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post Export Definitions", - "tags": [ - "Export Definitions", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search": { - "post": { - "operationId": "searchEntities@ExportDefinitions", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "summary" : "List all settings for a user", + "tags" : [ "User Settings", "entities", "user-model-controller" ] + }, + "post" : { + "operationId" : "createEntity@UserSettings", + "parameters" : [ { + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserSettingInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserSettingInDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserSettingOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserSettingOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for ExportDefinition", - "tags": [ - "Export Definitions", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "summary" : "Post new user settings for the user", + "tags" : [ "User Settings", "entities", "user-model-controller" ] } }, - "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}": { - "delete": { - "operationId": "deleteEntity@ExportDefinitions", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "/api/v1/entities/users/{userId}/userSettings/{id}" : { + "delete" : { + "operationId" : "deleteEntity@UserSettings", + "parameters" : [ { + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JsonNodeValue;type==SettingTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete an Export Definition", - "tags": [ - "Export Definitions", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } + }, + "summary" : "Delete a setting for a user", + "tags" : [ "User Settings", "entities", "user-model-controller" ] }, - "get": { - "operationId": "getEntity@ExportDefinitions", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "visualizationObjects", - "analyticalDashboards", - "automations", - "userIdentifiers", - "visualizationObject", - "analyticalDashboard", - "automation", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get an Export Definition", - "tags": [ - "Export Definitions", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "get" : { + "operationId" : "getEntity@UserSettings", + "parameters" : [ { + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JsonNodeValue;type==SettingTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserSettingOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserSettingOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get a setting for a user", + "tags" : [ "User Settings", "entities", "user-model-controller" ] }, - "patch": { - "operationId": "patchEntity@ExportDefinitions", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "visualizationObjects", - "analyticalDashboards", - "automations", - "userIdentifiers", - "visualizationObject", - "analyticalDashboard", - "automation", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionPatchDocument" + "put" : { + "operationId" : "updateEntity@UserSettings", + "parameters" : [ { + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JsonNodeValue;type==SettingTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserSettingInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserSettingInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserSettingOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserSettingOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch an Export Definition", - "tags": [ - "Export Definitions", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] + "summary" : "Put new user settings for the user", + "tags" : [ "User Settings", "entities", "user-model-controller" ] + } + }, + "/api/v1/entities/workspaces" : { + "get" : { + "description" : "Space of the shared interest", + "operationId" : "getAllEntities@Workspaces", + "parameters" : [ { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;earlyAccess==someString;parent.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "parent", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "workspaces", "parent", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=permissions,config,hierarchy,dataModelDatasets,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "permissions", "config", "hierarchy", "dataModelDatasets", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get Workspace entities", + "tags" : [ "Workspaces - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] } }, - "put": { - "operationId": "updateEntity@ExportDefinitions", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } + "post" : { + "description" : "Space of the shared interest", + "operationId" : "createEntity@Workspaces", + "parameters" : [ { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "parent", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "workspaces", "parent", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "style" : "form" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=permissions,config,hierarchy,dataModelDatasets,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "permissions", "config", "hierarchy", "dataModelDatasets", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "visualizationObjects", - "analyticalDashboards", - "automations", - "userIdentifiers", - "visualizationObject", - "analyticalDashboard", - "automation", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionInDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put an Export Definition", - "tags": [ - "Export Definitions", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] + "summary" : "Post Workspace entities", + "tags" : [ "Workspaces - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/facts": { - "get": { - "operationId": "getAllEntities@Facts", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;dataset.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "dataset", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "datasets", - "dataset", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFactOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFactOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Facts", - "tags": [ - "Facts", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "/api/v1/entities/workspaces/{id}" : { + "delete" : { + "description" : "Space of the shared interest", + "operationId" : "deleteEntity@Workspaces", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;earlyAccess==someString;parent.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete Workspace entity", + "tags" : [ "Workspaces - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/facts/search": { - "post": { - "operationId": "searchEntities@Facts", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + }, + "get" : { + "description" : "Space of the shared interest", + "operationId" : "getEntity@Workspaces", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;earlyAccess==someString;parent.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "parent", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "workspaces", "parent", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=permissions,config,hierarchy,dataModelDatasets,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "permissions", "config", "hierarchy", "dataModelDatasets", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get Workspace entity", + "tags" : [ "Workspaces - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "patch" : { + "description" : "Space of the shared interest", + "operationId" : "patchEntity@Workspaces", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;earlyAccess==someString;parent.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "parent", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "workspaces", "parent", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspacePatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspacePatchDocument" + } } }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Patch Workspace entity", + "tags" : [ "Workspaces - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] + } + }, + "put" : { + "description" : "Space of the shared interest", + "operationId" : "updateEntity@Workspaces", + "parameters" : [ { + "$ref" : "#/components/parameters/idPathParameter" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "name==someString;earlyAccess==someString;parent.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "parent", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "workspaces", "parent", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceInDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFactOutList" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFactOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for Fact", - "tags": [ - "Facts", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "summary" : "Put Workspace entity", + "tags" : [ "Workspaces - Entity APIs", "entities", "organization-model-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/facts/{objectId}": { - "get": { - "operationId": "getEntity@Facts", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;dataset.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "dataset", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "datasets", - "dataset", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFactOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFactOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get a Fact", - "tags": [ - "Facts", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - }, - "patch": { - "operationId": "patchEntity@Facts", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;dataset.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "dataset", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "datasets", - "dataset", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFactPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFactPatchDocument" + "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts" : { + "get" : { + "operationId" : "getAllEntities@AggregatedFacts", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "dataset,sourceFact", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "datasets", "facts", "dataset", "sourceFact", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAggregatedFactOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAggregatedFactOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "tags" : [ "Facts", "entities", "workspace-object-controller" ] + } + }, + "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search" : { + "post" : { + "operationId" : "searchEntities@AggregatedFacts", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" } } }, - "required": true + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFactOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAggregatedFactOutList" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFactOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAggregatedFactOutList" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch a Fact (beta)", - "tags": [ - "Facts", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "summary" : "Search request for AggregatedFact", + "tags" : [ "Facts", "entities", "workspace-object-controller" ] + } + }, + "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId}" : { + "get" : { + "operationId" : "getEntity@AggregatedFacts", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "dataset,sourceFact", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "datasets", "facts", "dataset", "sourceFact", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAggregatedFactOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAggregatedFactOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "tags" : [ "Facts", "entities", "workspace-object-controller" ] + } + }, + "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards" : { + "get" : { + "operationId" : "getAllEntities@AnalyticalDashboards", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "visualizationObjects", "analyticalDashboards", "labels", "metrics", "datasets", "filterContexts", "dashboardPlugins", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=permissions,origin,accessInfo,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "permissions", "origin", "accessInfo", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Dashboards", + "tags" : [ "Dashboards", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "post" : { + "operationId" : "createEntity@AnalyticalDashboards", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "visualizationObjects", "analyticalDashboards", "labels", "metrics", "datasets", "filterContexts", "dashboardPlugins", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=permissions,origin,accessInfo,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "permissions", "origin", "accessInfo", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Post Dashboards", + "tags" : [ "Dashboards", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/filterContexts": { - "get": { - "operationId": "getAllEntities@FilterContexts", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attributes,datasets,labels", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "attributes", - "datasets", - "labels", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Filter Context", - "tags": [ - "Filter Context", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search" : { + "post" : { + "operationId" : "searchEntities@AnalyticalDashboards", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" + } + } + }, + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Search request for AnalyticalDashboard", + "tags" : [ "Dashboards", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}" : { + "delete" : { + "operationId" : "deleteEntity@AnalyticalDashboards", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete a Dashboard", + "tags" : [ "Dashboards", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] } }, - "post": { - "operationId": "createEntity@FilterContexts", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "get" : { + "operationId" : "getEntity@AnalyticalDashboards", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "visualizationObjects", "analyticalDashboards", "labels", "metrics", "datasets", "filterContexts", "dashboardPlugins", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=permissions,origin,accessInfo,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "permissions", "origin", "accessInfo", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get a Dashboard", + "tags" : [ "Dashboards", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "patch" : { + "operationId" : "patchEntity@AnalyticalDashboards", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "visualizationObjects", "analyticalDashboards", "labels", "metrics", "datasets", "filterContexts", "dashboardPlugins", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attributes,datasets,labels", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "attributes", - "datasets", - "labels", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextPostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextPostOptionalIdDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post Filter Context", - "tags": [ - "Filter Context", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] + "summary" : "Patch a Dashboard", + "tags" : [ "Dashboards", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/filterContexts/search": { - "post": { - "operationId": "searchEntities@FilterContexts", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + }, + "put" : { + "operationId" : "updateEntity@AnalyticalDashboards", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "visualizationObjects", "analyticalDashboards", "labels", "metrics", "datasets", "filterContexts", "dashboardPlugins", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardInDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutList" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for FilterContext", - "tags": [ - "Filter Context", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "summary" : "Put Dashboards", + "tags" : [ "Dashboards", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}": { - "delete": { - "operationId": "deleteEntity@FilterContexts", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete a Filter Context", - "tags": [ - "Filter Context", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] + "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies" : { + "get" : { + "operationId" : "getAllEntities@AttributeHierarchies", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,attributes", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "attributes", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Attribute Hierarchies", + "tags" : [ "Attribute Hierarchies", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] } }, - "get": { - "operationId": "getEntity@FilterContexts", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attributes,datasets,labels", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "attributes", - "datasets", - "labels", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get a Filter Context", - "tags": [ - "Filter Context", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "post" : { + "operationId" : "createEntity@AttributeHierarchies", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,attributes", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "attributes", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyInDocument" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Post Attribute Hierarchies", + "tags" : [ "Attribute Hierarchies", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search" : { + "post" : { + "operationId" : "searchEntities@AttributeHierarchies", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" + } + } + }, + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Search request for AttributeHierarchy", + "tags" : [ "Attribute Hierarchies", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}" : { + "delete" : { + "operationId" : "deleteEntity@AttributeHierarchies", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete an Attribute Hierarchy", + "tags" : [ "Attribute Hierarchies", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] } }, - "patch": { - "operationId": "patchEntity@FilterContexts", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "get" : { + "operationId" : "getEntity@AttributeHierarchies", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,attributes", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "attributes", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get an Attribute Hierarchy", + "tags" : [ "Attribute Hierarchies", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "patch" : { + "operationId" : "patchEntity@AttributeHierarchies", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,attributes", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "attributes", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attributes,datasets,labels", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "attributes", - "datasets", - "labels", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextPatchDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch a Filter Context", - "tags": [ - "Filter Context", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] + "summary" : "Patch an Attribute Hierarchy", + "tags" : [ "Attribute Hierarchies", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] } }, - "put": { - "operationId": "updateEntity@FilterContexts", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "put" : { + "operationId" : "updateEntity@AttributeHierarchies", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,attributes", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "attributes", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attributes,datasets,labels", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "attributes", - "datasets", - "labels", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextInDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put a Filter Context", - "tags": [ - "Filter Context", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] + "summary" : "Put an Attribute Hierarchy", + "tags" : [ "Attribute Hierarchies", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/filterViews": { - "get": { - "operationId": "getAllEntities@FilterViews", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Filter views", - "tags": [ - "Filter Views", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - }, - "post": { - "operationId": "createEntity@FilterViews", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "/api/v1/entities/workspaces/{workspaceId}/attributes" : { + "get" : { + "operationId" : "getAllEntities@Attributes", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;dataset.id==321;defaultView.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "dataset,defaultView,labels,attributeHierarchies", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "datasets", "labels", "attributeHierarchies", "dataset", "defaultView", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Attributes", + "tags" : [ "Attributes", "entities", "workspace-object-controller" ] + } + }, + "/api/v1/entities/workspaces/{workspaceId}/attributes/search" : { + "post" : { + "operationId" : "searchEntities@Attributes", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" } } }, - "required": true + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeOutList" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeOutList" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post Filter views", - "tags": [ - "Filter Views", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", - "permissions": [ - "CREATE_FILTER_VIEW" - ] - } + "summary" : "Search request for Attribute", + "tags" : [ "Attributes", "entities", "workspace-object-controller" ] } }, - "/api/v1/entities/workspaces/{workspaceId}/filterViews/search": { - "post": { - "operationId": "searchEntities@FilterViews", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" + "/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}" : { + "get" : { + "operationId" : "getEntity@Attributes", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;dataset.id==321;defaultView.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "dataset,defaultView,labels,attributeHierarchies", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "datasets", "labels", "attributeHierarchies", "dataset", "defaultView", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get an Attribute", + "tags" : [ "Attributes", "entities", "workspace-object-controller" ] + }, + "patch" : { + "operationId" : "patchEntity@Attributes", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;dataset.id==321;defaultView.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "dataset,defaultView,labels,attributeHierarchies", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "datasets", "labels", "attributeHierarchies", "dataset", "defaultView", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributePatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributePatchDocument" + } } }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAttributeOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Patch an Attribute (beta)", + "tags" : [ "Attributes", "entities", "workspace-object-controller" ] + } + }, + "/api/v1/entities/workspaces/{workspaceId}/automationResults/search" : { + "post" : { + "operationId" : "searchEntities@AutomationResults", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationResultOutList" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationResultOutList" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for FilterView", - "tags": [ - "Filter Views", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "summary" : "Search request for AutomationResult", + "tags" : [ "Automations", "entities", "workspace-object-controller" ] + } + }, + "/api/v1/entities/workspaces/{workspaceId}/automations" : { + "get" : { + "operationId" : "getAllEntities@Automations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Automations", + "tags" : [ "Automations", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "post" : { + "operationId" : "createEntity@Automations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationInDocument" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Post Automations", + "tags" : [ "Automations", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "CREATE_AUTOMATION" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}": { - "delete": { - "operationId": "deleteEntity@FilterViews", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete Filter view", - "tags": [ - "Filter Views", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", - "permissions": [ - "CREATE_FILTER_VIEW" - ] + "/api/v1/entities/workspaces/{workspaceId}/automations/search" : { + "post" : { + "operationId" : "searchEntities@Automations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" + } + } + }, + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Search request for Automation", + "tags" : [ "Automations", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}" : { + "delete" : { + "operationId" : "deleteEntity@Automations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete an Automation", + "tags" : [ "Automations", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "CREATE_AUTOMATION" ] } }, - "get": { - "operationId": "getEntity@FilterViews", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } + "get" : { + "operationId" : "getEntity@Automations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get an Automation", + "tags" : [ "Automations", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "patch" : { + "operationId" : "patchEntity@Automations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationPatchDocument" + } } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Get Filter view", - "tags": [ - "Filter Views", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "summary" : "Patch an Automation", + "tags" : [ "Automations", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "CREATE_AUTOMATION" ] } }, - "patch": { - "operationId": "patchEntity@FilterViews", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "put" : { + "operationId" : "updateEntity@Automations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiAutomationOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch Filter view", - "tags": [ - "Filter Views", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", - "permissions": [ - "CREATE_FILTER_VIEW" - ] + "summary" : "Put an Automation", + "tags" : [ "Automations", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "CREATE_AUTOMATION" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings" : { + "get" : { + "operationId" : "getAllEntities@CustomApplicationSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "applicationName==someString;content==JsonNodeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Custom Application Settings", + "tags" : [ "Workspaces - Settings", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] } }, - "put": { - "operationId": "updateEntity@FilterViews", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "post" : { + "operationId" : "createEntity@CustomApplicationSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put Filter views", - "tags": [ - "Filter Views", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", - "permissions": [ - "CREATE_FILTER_VIEW" - ] + "summary" : "Post Custom Application Settings", + "tags" : [ "Workspaces - Settings", "entities", "workspace-object-controller" ] + } + }, + "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search" : { + "post" : { + "operationId" : "searchEntities@CustomApplicationSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" + } + } + }, + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Search request for CustomApplicationSetting", + "tags" : [ "Workspaces - Settings", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations": { - "get": { - "operationId": "getAllEntities@KnowledgeRecommendations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "tags": [ - "AI", - "entities", - "workspace-object-controller" - ] - }, - "post": { - "operationId": "createEntity@KnowledgeRecommendations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}" : { + "delete" : { + "operationId" : "deleteEntity@CustomApplicationSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "applicationName==someString;content==JsonNodeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete a Custom Application Setting", + "tags" : [ "Workspaces - Settings", "entities", "workspace-object-controller" ] + }, + "get" : { + "operationId" : "getEntity@CustomApplicationSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "applicationName==someString;content==JsonNodeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get a Custom Application Setting", + "tags" : [ "Workspaces - Settings", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "patch" : { + "operationId" : "patchEntity@CustomApplicationSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "applicationName==someString;content==JsonNodeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" + } + }, + "summary" : "Patch a Custom Application Setting", + "tags" : [ "Workspaces - Settings", "entities", "workspace-object-controller" ] + }, + "put" : { + "operationId" : "updateEntity@CustomApplicationSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - }, - "tags": [ - "AI", - "entities", - "workspace-object-controller" - ] - } - }, - "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search": { - "post": { - "operationId": "searchEntities@KnowledgeRecommendations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "applicationName==someString;content==JsonNodeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingInDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "tags": [ - "AI", - "entities", - "workspace-object-controller" - ] + "summary" : "Put a Custom Application Setting", + "tags" : [ "Workspaces - Settings", "entities", "workspace-object-controller" ] } }, - "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}": { - "delete": { - "operationId": "deleteEntity@KnowledgeRecommendations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins" : { + "get" : { + "operationId" : "getAllEntities@DashboardPlugins", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Plugins", + "tags" : [ "Plugins", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "post" : { + "operationId" : "createEntity@DashboardPlugins", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Post Plugins", + "tags" : [ "Plugins", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search" : { + "post" : { + "operationId" : "searchEntities@DashboardPlugins", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" + } + } + }, + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Search request for DashboardPlugin", + "tags" : [ "Plugins", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}" : { + "delete" : { + "operationId" : "deleteEntity@DashboardPlugins", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete a Plugin", + "tags" : [ "Plugins", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] + } + }, + "get" : { + "operationId" : "getEntity@DashboardPlugins", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get a Plugin", + "tags" : [ "Plugins", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "patch" : { + "operationId" : "patchEntity@DashboardPlugins", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "tags": [ - "AI", - "entities", - "workspace-object-controller" - ] - }, - "get": { - "operationId": "getEntity@KnowledgeRecommendations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "tags": [ - "AI", - "entities", - "workspace-object-controller" - ] - }, - "patch": { - "operationId": "patchEntity@KnowledgeRecommendations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "tags": [ - "AI", - "entities", - "workspace-object-controller" - ] + "summary" : "Patch a Plugin", + "tags" : [ "Plugins", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] + } }, - "put": { - "operationId": "updateEntity@KnowledgeRecommendations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "put" : { + "operationId" : "updateEntity@DashboardPlugins", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "tags": [ - "AI", - "entities", - "workspace-object-controller" - ] + "summary" : "Put a Plugin", + "tags" : [ "Plugins", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/labels": { - "get": { - "operationId": "getAllEntities@Labels", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;attribute.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attribute", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "attributes", - "attribute", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Labels", - "tags": [ - "Labels", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "/api/v1/entities/workspaces/{workspaceId}/datasets" : { + "get" : { + "operationId" : "getAllEntities@Datasets", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "attributes", "facts", "aggregatedFacts", "datasets", "workspaceDataFilters", "references", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDatasetOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDatasetOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Datasets", + "tags" : [ "Datasets", "entities", "workspace-object-controller" ] } }, - "/api/v1/entities/workspaces/{workspaceId}/labels/search": { - "post": { - "operationId": "searchEntities@Labels", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "/api/v1/entities/workspaces/{workspaceId}/datasets/search" : { + "post" : { + "operationId" : "searchEntities@Datasets", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDatasetOutList" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDatasetOutList" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for Label", - "tags": [ - "Labels", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "summary" : "Search request for Dataset", + "tags" : [ "Datasets", "entities", "workspace-object-controller" ] } }, - "/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}": { - "get": { - "operationId": "getEntity@Labels", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;attribute.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attribute", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "attributes", - "attribute", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get a Label", - "tags": [ - "Labels", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - }, - "patch": { - "operationId": "patchEntity@Labels", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;attribute.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attribute", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "attributes", - "attribute", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLabelPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLabelPatchDocument" + "/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}" : { + "get" : { + "operationId" : "getEntity@Datasets", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "attributes", "facts", "aggregatedFacts", "datasets", "workspaceDataFilters", "references", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDatasetOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDatasetOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get a Dataset", + "tags" : [ "Datasets", "entities", "workspace-object-controller" ] + }, + "patch" : { + "operationId" : "patchEntity@Datasets", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "attributes,facts,aggregatedFacts,references,workspaceDataFilters", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "attributes", "facts", "aggregatedFacts", "datasets", "workspaceDataFilters", "references", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDatasetPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDatasetPatchDocument" } } }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDatasetOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiDatasetOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch a Label (beta)", - "tags": [ - "Labels", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "summary" : "Patch a Dataset (beta)", + "tags" : [ "Datasets", "entities", "workspace-object-controller" ] + } + }, + "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions" : { + "get" : { + "operationId" : "getAllEntities@ExportDefinitions", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "visualizationObjects", "analyticalDashboards", "automations", "userIdentifiers", "visualizationObject", "analyticalDashboard", "automation", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Export Definitions", + "tags" : [ "Export Definitions", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "post" : { + "operationId" : "createEntity@ExportDefinitions", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "visualizationObjects", "analyticalDashboards", "automations", "userIdentifiers", "visualizationObject", "analyticalDashboard", "automation", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionPostOptionalIdDocument" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Post Export Definitions", + "tags" : [ "Export Definitions", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/memoryItems": { - "get": { - "operationId": "getAllEntities@MemoryItems", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "tags": [ - "AI", - "entities", - "workspace-object-controller" - ] - }, - "post": { - "operationId": "createEntity@MemoryItems", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search" : { + "post" : { + "operationId" : "searchEntities@ExportDefinitions", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" + } + } + }, + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Search request for ExportDefinition", + "tags" : [ "Export Definitions", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}" : { + "delete" : { + "operationId" : "deleteEntity@ExportDefinitions", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete an Export Definition", + "tags" : [ "Export Definitions", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] + } + }, + "get" : { + "operationId" : "getEntity@ExportDefinitions", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "visualizationObjects", "analyticalDashboards", "automations", "userIdentifiers", "visualizationObject", "analyticalDashboard", "automation", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get an Export Definition", + "tags" : [ "Export Definitions", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "patch" : { + "operationId" : "patchEntity@ExportDefinitions", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "visualizationObjects", "analyticalDashboards", "automations", "userIdentifiers", "visualizationObject", "analyticalDashboard", "automation", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "tags": [ - "AI", - "entities", - "workspace-object-controller" - ] - } - }, - "/api/v1/entities/workspaces/{workspaceId}/memoryItems/search": { - "post": { - "operationId": "searchEntities@MemoryItems", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "summary" : "Patch an Export Definition", + "tags" : [ "Export Definitions", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] + } + }, + "put" : { + "operationId" : "updateEntity@ExportDefinitions", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "visualizationObjects", "analyticalDashboards", "automations", "userIdentifiers", "visualizationObject", "analyticalDashboard", "automation", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionInDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiExportDefinitionOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for MemoryItem", - "tags": [ - "AI", - "entities", - "workspace-object-controller" - ] + "summary" : "Put an Export Definition", + "tags" : [ "Export Definitions", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}": { - "delete": { - "operationId": "deleteEntity@MemoryItems", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "/api/v1/entities/workspaces/{workspaceId}/facts" : { + "get" : { + "operationId" : "getAllEntities@Facts", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;dataset.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "dataset", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "datasets", "dataset", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFactOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFactOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Facts", + "tags" : [ "Facts", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/facts/search" : { + "post" : { + "operationId" : "searchEntities@Facts", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" + } + } + }, + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFactOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFactOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Search request for Fact", + "tags" : [ "Facts", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/facts/{objectId}" : { + "get" : { + "operationId" : "getEntity@Facts", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;dataset.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "dataset", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "datasets", "dataset", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFactOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFactOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get a Fact", + "tags" : [ "Facts", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "patch" : { + "operationId" : "patchEntity@Facts", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "tags": [ - "AI", - "entities", - "workspace-object-controller" - ] - }, - "get": { - "operationId": "getEntity@MemoryItems", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "tags": [ - "AI", - "entities", - "workspace-object-controller" - ] - }, - "patch": { - "operationId": "patchEntity@MemoryItems", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;dataset.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "dataset", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "datasets", "dataset", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFactPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFactPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFactOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFactOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "tags": [ - "AI", - "entities", - "workspace-object-controller" - ] + "summary" : "Patch a Fact (beta)", + "tags" : [ "Facts", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/filterContexts" : { + "get" : { + "operationId" : "getAllEntities@FilterContexts", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "attributes,datasets,labels", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "attributes", "datasets", "labels", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Filter Context", + "tags" : [ "Filter Context", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } }, - "put": { - "operationId": "updateEntity@MemoryItems", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "post" : { + "operationId" : "createEntity@FilterContexts", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "attributes,datasets,labels", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "attributes", "datasets", "labels", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextPostOptionalIdDocument" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Post Filter Context", + "tags" : [ "Filter Context", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/filterContexts/search" : { + "post" : { + "operationId" : "searchEntities@FilterContexts", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" + } + } + }, + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Search request for FilterContext", + "tags" : [ "Filter Context", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}" : { + "delete" : { + "operationId" : "deleteEntity@FilterContexts", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete a Filter Context", + "tags" : [ "Filter Context", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] + } + }, + "get" : { + "operationId" : "getEntity@FilterContexts", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "attributes,datasets,labels", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "attributes", "datasets", "labels", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get a Filter Context", + "tags" : [ "Filter Context", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "patch" : { + "operationId" : "patchEntity@FilterContexts", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "attributes,datasets,labels", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "attributes", "datasets", "labels", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "tags": [ - "AI", - "entities", - "workspace-object-controller" - ] - } - }, - "/api/v1/entities/workspaces/{workspaceId}/metrics": { - "get": { - "operationId": "getAllEntities@Metrics", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Metrics", - "tags": [ - "Metrics", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "summary" : "Patch a Filter Context", + "tags" : [ "Filter Context", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] } }, - "post": { - "operationId": "createEntity@Metrics", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "put" : { + "operationId" : "updateEntity@FilterContexts", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "attributes,datasets,labels", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "attributes", "datasets", "labels", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterContextOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post Metrics", - "tags": [ - "Metrics", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "summary" : "Put a Filter Context", + "tags" : [ "Filter Context", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/metrics/search": { - "post": { - "operationId": "searchEntities@Metrics", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "/api/v1/entities/workspaces/{workspaceId}/filterViews" : { + "get" : { + "operationId" : "getAllEntities@FilterViews", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "analyticalDashboard,user", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "analyticalDashboards", "users", "analyticalDashboard", "user", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Filter views", + "tags" : [ "Filter Views", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "post" : { + "operationId" : "createEntity@FilterViews", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "analyticalDashboard,user", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "analyticalDashboards", "users", "analyticalDashboard", "user", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewInDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for Metric", - "tags": [ - "Metrics", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "summary" : "Post Filter views", + "tags" : [ "Filter Views", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage Filter Views", + "permissions" : [ "CREATE_FILTER_VIEW" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}": { - "delete": { - "operationId": "deleteEntity@Metrics", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete a Metric", - "tags": [ - "Metrics", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "/api/v1/entities/workspaces/{workspaceId}/filterViews/search" : { + "post" : { + "operationId" : "searchEntities@FilterViews", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" + } + } + }, + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Search request for FilterView", + "tags" : [ "Filter Views", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}" : { + "delete" : { + "operationId" : "deleteEntity@FilterViews", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete Filter view", + "tags" : [ "Filter Views", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage Filter Views", + "permissions" : [ "CREATE_FILTER_VIEW" ] } }, - "get": { - "operationId": "getEntity@Metrics", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get a Metric", - "tags": [ - "Metrics", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "get" : { + "operationId" : "getEntity@FilterViews", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "analyticalDashboard,user", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "analyticalDashboards", "users", "analyticalDashboard", "user", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get Filter view", + "tags" : [ "Filter Views", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] } }, - "patch": { - "operationId": "patchEntity@Metrics", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "patch" : { + "operationId" : "patchEntity@FilterViews", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "analyticalDashboard,user", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "analyticalDashboards", "users", "analyticalDashboard", "user", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricPatchDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch a Metric", - "tags": [ - "Metrics", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "summary" : "Patch Filter view", + "tags" : [ "Filter Views", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage Filter Views", + "permissions" : [ "CREATE_FILTER_VIEW" ] } }, - "put": { - "operationId": "updateEntity@Metrics", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "put" : { + "operationId" : "updateEntity@FilterViews", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "analyticalDashboard,user", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "analyticalDashboards", "users", "analyticalDashboard", "user", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricInDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiFilterViewOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put a Metric", - "tags": [ - "Metrics", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] + "summary" : "Put Filter views", + "tags" : [ "Filter Views", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage Filter Views", + "permissions" : [ "CREATE_FILTER_VIEW" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/userDataFilters": { - "get": { - "operationId": "getAllEntities@UserDataFilters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;user.id==321;userGroup.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "users", - "userGroups", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "user", - "userGroup", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all User Data Filters", - "tags": [ - "Data Filters", - "entities", - "workspace-object-controller" - ] - }, - "post": { - "operationId": "createEntity@UserDataFilters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "users", - "userGroups", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "user", - "userGroup", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalIdDocument" - } - } - }, - "required": true + "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations" : { + "get" : { + "operationId" : "getAllEntities@KnowledgeRecommendations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "metric,analyticalDashboard", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "metrics", "analyticalDashboards", "metric", "analyticalDashboard", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "tags" : [ "AI", "entities", "workspace-object-controller" ] + }, + "post" : { + "operationId" : "createEntity@KnowledgeRecommendations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "metric,analyticalDashboard", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "metrics", "analyticalDashboards", "metric", "analyticalDashboard", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + } + } + }, + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post User Data Filters", - "tags": [ - "Data Filters", - "entities", - "workspace-object-controller" - ] + "tags" : [ "AI", "entities", "workspace-object-controller" ] } }, - "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/search": { - "post": { - "operationId": "searchEntities@UserDataFilters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search" : { + "post" : { + "operationId" : "searchEntities@KnowledgeRecommendations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationOutList" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationOutList" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for UserDataFilter", - "tags": [ - "Data Filters", - "entities", - "workspace-object-controller" - ] + "tags" : [ "AI", "entities", "workspace-object-controller" ] } }, - "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}": { - "delete": { - "operationId": "deleteEntity@UserDataFilters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;user.id==321;userGroup.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete a User Data Filter", - "tags": [ - "Data Filters", - "entities", - "workspace-object-controller" - ] - }, - "get": { - "operationId": "getEntity@UserDataFilters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;user.id==321;userGroup.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "users", - "userGroups", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "user", - "userGroup", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get a User Data Filter", - "tags": [ - "Data Filters", - "entities", - "workspace-object-controller" - ] - }, - "patch": { - "operationId": "patchEntity@UserDataFilters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;user.id==321;userGroup.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "users", - "userGroups", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "user", - "userGroup", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPatchDocument" + "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}" : { + "delete" : { + "operationId" : "deleteEntity@KnowledgeRecommendations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "tags" : [ "AI", "entities", "workspace-object-controller" ] + }, + "get" : { + "operationId" : "getEntity@KnowledgeRecommendations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "metric,analyticalDashboard", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "metrics", "analyticalDashboards", "metric", "analyticalDashboard", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "tags" : [ "AI", "entities", "workspace-object-controller" ] + }, + "patch" : { + "operationId" : "patchEntity@KnowledgeRecommendations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "metric,analyticalDashboard", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "metrics", "analyticalDashboards", "metric", "analyticalDashboard", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch a User Data Filter", - "tags": [ - "Data Filters", - "entities", - "workspace-object-controller" - ] + "tags" : [ "AI", "entities", "workspace-object-controller" ] }, - "put": { - "operationId": "updateEntity@UserDataFilters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;user.id==321;userGroup.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "put" : { + "operationId" : "updateEntity@KnowledgeRecommendations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "metric,analyticalDashboard", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "metrics", "analyticalDashboards", "metric", "analyticalDashboard", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "users", - "userGroups", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "user", - "userGroup", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterInDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put a User Data Filter", - "tags": [ - "Data Filters", - "entities", - "workspace-object-controller" - ] + "tags" : [ "AI", "entities", "workspace-object-controller" ] } }, - "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects": { - "get": { - "operationId": "getAllEntities@VisualizationObjects", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Visualization Objects", - "tags": [ - "Visualization Object", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "/api/v1/entities/workspaces/{workspaceId}/labels" : { + "get" : { + "operationId" : "getAllEntities@Labels", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;attribute.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "attribute", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "attributes", "attribute", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLabelOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLabelOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Labels", + "tags" : [ "Labels", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/labels/search" : { + "post" : { + "operationId" : "searchEntities@Labels", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" + } + } + }, + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLabelOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLabelOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Search request for Label", + "tags" : [ "Labels", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}" : { + "get" : { + "operationId" : "getEntity@Labels", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;attribute.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "attribute", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "attributes", "attribute", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLabelOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLabelOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get a Label", + "tags" : [ "Labels", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] } }, - "post": { - "operationId": "createEntity@VisualizationObjects", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "patch" : { + "operationId" : "patchEntity@Labels", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;attribute.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "attribute", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "attributes", "attribute", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalIdDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLabelPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLabelPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLabelOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiLabelOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post Visualization Objects", - "tags": [ - "Visualization Object", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] + "summary" : "Patch a Label (beta)", + "tags" : [ "Labels", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search": { - "post": { - "operationId": "searchEntities@VisualizationObjects", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "/api/v1/entities/workspaces/{workspaceId}/memoryItems" : { + "get" : { + "operationId" : "getAllEntities@MemoryItems", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "tags" : [ "AI", "entities", "workspace-object-controller" ] + }, + "post" : { + "operationId" : "createEntity@MemoryItems", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "tags" : [ "AI", "entities", "workspace-object-controller" ] + } + }, + "/api/v1/entities/workspaces/{workspaceId}/memoryItems/search" : { + "post" : { + "operationId" : "searchEntities@MemoryItems", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemOutList" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemOutList" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for VisualizationObject", - "tags": [ - "Visualization Object", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "summary" : "Search request for MemoryItem", + "tags" : [ "AI", "entities", "workspace-object-controller" ] } }, - "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}": { - "delete": { - "operationId": "deleteEntity@VisualizationObjects", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete a Visualization Object", - "tags": [ - "Visualization Object", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } - }, - "get": { - "operationId": "getEntity@VisualizationObjects", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get a Visualization Object", - "tags": [ - "Visualization Object", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - }, - "patch": { - "operationId": "patchEntity@VisualizationObjects", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPatchDocument" + "/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}" : { + "delete" : { + "operationId" : "deleteEntity@MemoryItems", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "tags" : [ "AI", "entities", "workspace-object-controller" ] + }, + "get" : { + "operationId" : "getEntity@MemoryItems", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "tags" : [ "AI", "entities", "workspace-object-controller" ] + }, + "patch" : { + "operationId" : "patchEntity@MemoryItems", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch a Visualization Object", - "tags": [ - "Visualization Object", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } + "tags" : [ "AI", "entities", "workspace-object-controller" ] }, - "put": { - "operationId": "updateEntity@VisualizationObjects", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "put" : { + "operationId" : "updateEntity@MemoryItems", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectInDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put a Visualization Object", - "tags": [ - "Visualization Object", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] + "tags" : [ "AI", "entities", "workspace-object-controller" ] + } + }, + "/api/v1/entities/workspaces/{workspaceId}/metrics" : { + "get" : { + "operationId" : "getAllEntities@Metrics", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "datasets", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Metrics", + "tags" : [ "Metrics", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "post" : { + "operationId" : "createEntity@Metrics", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "datasets", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Post Metrics", + "tags" : [ "Metrics", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings": { - "get": { - "operationId": "getAllEntities@WorkspaceDataFilterSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspaceDataFilter.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "/api/v1/entities/workspaces/{workspaceId}/metrics/search" : { + "post" : { + "operationId" : "searchEntities@Metrics", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" + } + } + }, + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Search request for Metric", + "tags" : [ "Metrics", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}" : { + "delete" : { + "operationId" : "deleteEntity@Metrics", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete a Metric", + "tags" : [ "Metrics", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] + } + }, + "get" : { + "operationId" : "getEntity@Metrics", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "datasets", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get a Metric", + "tags" : [ "Metrics", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "patch" : { + "operationId" : "patchEntity@Metrics", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "datasets", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspaceDataFilter", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilters", - "workspaceDataFilter", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricPatchDocument" + } } }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Settings for Workspace Data Filters", - "tags": [ - "Data Filters", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Patch a Metric", + "tags" : [ "Metrics", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } }, - "post": { - "operationId": "createEntity@WorkspaceDataFilterSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "put" : { + "operationId" : "updateEntity@Metrics", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "datasets", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspaceDataFilter", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilters", - "workspaceDataFilter", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiMetricOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post Settings for Workspace Data Filters", - "tags": [ - "Data Filters", - "entities", - "workspace-object-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.", - "permissions": [ - "MANAGE" - ] + "summary" : "Put a Metric", + "tags" : [ "Metrics", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search": { - "post": { - "operationId": "searchEntities@WorkspaceDataFilterSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "/api/v1/entities/workspaces/{workspaceId}/userDataFilters" : { + "get" : { + "operationId" : "getAllEntities@UserDataFilters", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;user.id==321;userGroup.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "user,userGroup,facts,attributes,labels,metrics,datasets", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "users", "userGroups", "facts", "attributes", "labels", "metrics", "datasets", "user", "userGroup", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all User Data Filters", + "tags" : [ "Data Filters", "entities", "workspace-object-controller" ] + }, + "post" : { + "operationId" : "createEntity@UserDataFilters", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "user,userGroup,facts,attributes,labels,metrics,datasets", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "users", "userGroups", "facts", "attributes", "labels", "metrics", "datasets", "user", "userGroup", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterPostOptionalIdDocument" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Post User Data Filters", + "tags" : [ "Data Filters", "entities", "workspace-object-controller" ] + } + }, + "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/search" : { + "post" : { + "operationId" : "searchEntities@UserDataFilters", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterOutList" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterOutList" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for WorkspaceDataFilterSetting", - "tags": [ - "Data Filters", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "summary" : "Search request for UserDataFilter", + "tags" : [ "Data Filters", "entities", "workspace-object-controller" ] } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}": { - "delete": { - "operationId": "deleteEntity@WorkspaceDataFilterSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspaceDataFilter.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete a Settings for Workspace Data Filter", - "tags": [ - "Data Filters", - "entities", - "workspace-object-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.", - "permissions": [ - "MANAGE" - ] - } - }, - "get": { - "operationId": "getEntity@WorkspaceDataFilterSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspaceDataFilter.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspaceDataFilter", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilters", - "workspaceDataFilter", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get a Setting for Workspace Data Filter", - "tags": [ - "Data Filters", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - }, - "patch": { - "operationId": "patchEntity@WorkspaceDataFilterSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspaceDataFilter.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspaceDataFilter", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilters", - "workspaceDataFilter", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatchDocument" + "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}" : { + "delete" : { + "operationId" : "deleteEntity@UserDataFilters", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;user.id==321;userGroup.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete a User Data Filter", + "tags" : [ "Data Filters", "entities", "workspace-object-controller" ] + }, + "get" : { + "operationId" : "getEntity@UserDataFilters", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;user.id==321;userGroup.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "user,userGroup,facts,attributes,labels,metrics,datasets", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "users", "userGroups", "facts", "attributes", "labels", "metrics", "datasets", "user", "userGroup", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get a User Data Filter", + "tags" : [ "Data Filters", "entities", "workspace-object-controller" ] + }, + "patch" : { + "operationId" : "patchEntity@UserDataFilters", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;user.id==321;userGroup.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "user,userGroup,facts,attributes,labels,metrics,datasets", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "users", "userGroups", "facts", "attributes", "labels", "metrics", "datasets", "user", "userGroup", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch a Settings for Workspace Data Filter", - "tags": [ - "Data Filters", - "entities", - "workspace-object-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.", - "permissions": [ - "MANAGE" - ] - } + "summary" : "Patch a User Data Filter", + "tags" : [ "Data Filters", "entities", "workspace-object-controller" ] }, - "put": { - "operationId": "updateEntity@WorkspaceDataFilterSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspaceDataFilter.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "put" : { + "operationId" : "updateEntity@UserDataFilters", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;user.id==321;userGroup.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "user,userGroup,facts,attributes,labels,metrics,datasets", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "users", "userGroups", "facts", "attributes", "labels", "metrics", "datasets", "user", "userGroup", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "workspaceDataFilter", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilters", - "workspaceDataFilter", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiUserDataFilterOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put a Settings for Workspace Data Filter", - "tags": [ - "Data Filters", - "entities", - "workspace-object-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.", - "permissions": [ - "MANAGE" - ] + "summary" : "Put a User Data Filter", + "tags" : [ "Data Filters", "entities", "workspace-object-controller" ] + } + }, + "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects" : { + "get" : { + "operationId" : "getAllEntities@VisualizationObjects", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "datasets", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Visualization Objects", + "tags" : [ "Visualization Object", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "post" : { + "operationId" : "createEntity@VisualizationObjects", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "datasets", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectPostOptionalIdDocument" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Post Visualization Objects", + "tags" : [ "Visualization Object", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters": { - "get": { - "operationId": "getAllEntities@WorkspaceDataFilters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "filterSettings", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilterSettings", - "filterSettings", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Workspace Data Filters", - "tags": [ - "Data Filters", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search" : { + "post" : { + "operationId" : "searchEntities@VisualizationObjects", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" + } + } + }, + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Search request for VisualizationObject", + "tags" : [ "Visualization Object", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}" : { + "delete" : { + "operationId" : "deleteEntity@VisualizationObjects", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete a Visualization Object", + "tags" : [ "Visualization Object", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] } }, - "post": { - "operationId": "createEntity@WorkspaceDataFilters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "get" : { + "operationId" : "getEntity@VisualizationObjects", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "datasets", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get a Visualization Object", + "tags" : [ "Visualization Object", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "patch" : { + "operationId" : "patchEntity@VisualizationObjects", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "datasets", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "filterSettings", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilterSettings", - "filterSettings", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post Workspace Data Filters", - "tags": [ - "Data Filters", - "entities", - "workspace-object-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.", - "permissions": [ - "MANAGE" - ] + "summary" : "Patch a Visualization Object", + "tags" : [ "Visualization Object", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search": { - "post": { - "operationId": "searchEntities@WorkspaceDataFilters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + }, + "put" : { + "operationId" : "updateEntity@VisualizationObjects", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "createdBy,modifiedBy,facts,attributes,labels,metrics,datasets", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "datasets", "createdBy", "modifiedBy", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectInDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiVisualizationObjectOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Search request for WorkspaceDataFilter", - "tags": [ - "Data Filters", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "summary" : "Put a Visualization Object", + "tags" : [ "Visualization Object", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to manage this object type.", + "permissions" : [ "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}": { - "delete": { - "operationId": "deleteEntity@WorkspaceDataFilters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete a Workspace Data Filter", - "tags": [ - "Data Filters", - "entities", - "workspace-object-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.", - "permissions": [ - "MANAGE" - ] + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings" : { + "get" : { + "operationId" : "getAllEntities@WorkspaceDataFilterSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;workspaceDataFilter.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "workspaceDataFilter", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "workspaceDataFilters", "workspaceDataFilter", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Settings for Workspace Data Filters", + "tags" : [ "Data Filters", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] } }, - "get": { - "operationId": "getEntity@WorkspaceDataFilters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "filterSettings", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilterSettings", - "filterSettings", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get a Workspace Data Filter", - "tags": [ - "Data Filters", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "post" : { + "operationId" : "createEntity@WorkspaceDataFilterSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "workspaceDataFilter", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "workspaceDataFilters", "workspaceDataFilter", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Post Settings for Workspace Data Filters", + "tags" : [ "Data Filters", "entities", "workspace-object-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.", + "permissions" : [ "MANAGE" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search" : { + "post" : { + "operationId" : "searchEntities@WorkspaceDataFilterSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" + } + } + }, + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Search request for WorkspaceDataFilterSetting", + "tags" : [ "Data Filters", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}" : { + "delete" : { + "operationId" : "deleteEntity@WorkspaceDataFilterSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;workspaceDataFilter.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete a Settings for Workspace Data Filter", + "tags" : [ "Data Filters", "entities", "workspace-object-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.", + "permissions" : [ "MANAGE" ] } }, - "patch": { - "operationId": "patchEntity@WorkspaceDataFilters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "get" : { + "operationId" : "getEntity@WorkspaceDataFilterSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;workspaceDataFilter.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "workspaceDataFilter", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "workspaceDataFilters", "workspaceDataFilter", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get a Setting for Workspace Data Filter", + "tags" : [ "Data Filters", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "patch" : { + "operationId" : "patchEntity@WorkspaceDataFilterSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;workspaceDataFilter.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "workspaceDataFilter", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "workspaceDataFilters", "workspaceDataFilter", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "filterSettings", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilterSettings", - "filterSettings", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatchDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch a Workspace Data Filter", - "tags": [ - "Data Filters", - "entities", - "workspace-object-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.", - "permissions": [ - "MANAGE" - ] + "summary" : "Patch a Settings for Workspace Data Filter", + "tags" : [ "Data Filters", "entities", "workspace-object-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.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "operationId": "updateEntity@WorkspaceDataFilters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "put" : { + "operationId" : "updateEntity@WorkspaceDataFilterSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString;workspaceDataFilter.id==321", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "workspaceDataFilter", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "workspaceDataFilters", "workspaceDataFilter", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "filterSettings", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaceDataFilterSettings", - "filterSettings", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put a Workspace Data Filter", - "tags": [ - "Data Filters", - "entities", - "workspace-object-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.", - "permissions": [ - "MANAGE" - ] + "summary" : "Put a Settings for Workspace Data Filter", + "tags" : [ "Data Filters", "entities", "workspace-object-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.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings": { - "get": { - "operationId": "getAllEntities@WorkspaceSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters" : { + "get" : { + "operationId" : "getAllEntities@WorkspaceDataFilters", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "filterSettings", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "workspaceDataFilterSettings", "filterSettings", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Workspace Data Filters", + "tags" : [ "Data Filters", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "post" : { + "operationId" : "createEntity@WorkspaceDataFilters", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "filterSettings", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "workspaceDataFilterSettings", "filterSettings", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Post Workspace Data Filters", + "tags" : [ "Data Filters", "entities", "workspace-object-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.", + "permissions" : [ "MANAGE" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search" : { + "post" : { + "operationId" : "searchEntities@WorkspaceDataFilters", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" + } + } + }, + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Search request for WorkspaceDataFilter", + "tags" : [ "Data Filters", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}" : { + "delete" : { + "operationId" : "deleteEntity@WorkspaceDataFilters", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete a Workspace Data Filter", + "tags" : [ "Data Filters", "entities", "workspace-object-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.", + "permissions" : [ "MANAGE" ] + } + }, + "get" : { + "operationId" : "getEntity@WorkspaceDataFilters", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "filterSettings", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "workspaceDataFilterSettings", "filterSettings", "ALL" ], + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get a Workspace Data Filter", + "tags" : [ "Data Filters", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "patch" : { + "operationId" : "patchEntity@WorkspaceDataFilters", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "filterSettings", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "workspaceDataFilterSettings", "filterSettings", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterPatchDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterPatchDocument" + } } }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Setting for Workspaces", - "tags": [ - "Workspaces - Settings", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Patch a Workspace Data Filter", + "tags" : [ "Data Filters", "entities", "workspace-object-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.", + "permissions" : [ "MANAGE" ] } }, - "post": { - "operationId": "createEntity@WorkspaceSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "put" : { + "operationId" : "updateEntity@WorkspaceDataFilters", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "title==someString;description==someString", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "description" : "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example" : "filterSettings", + "explode" : false, + "in" : "query", + "name" : "include", + "required" : false, + "schema" : { + "items" : { + "enum" : [ "workspaceDataFilterSettings", "filterSettings", "ALL" ], + "type" : "string" + }, + "type" : "array" }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalIdDocument" + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Post Settings for Workspaces", - "tags": [ - "Workspaces - Settings", - "entities", - "workspace-object-controller" - ] + "summary" : "Put a Workspace Data Filter", + "tags" : [ "Data Filters", "entities", "workspace-object-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.", + "permissions" : [ "MANAGE" ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search": { - "post": { - "operationId": "searchEntities@WorkspaceSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } + "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings" : { + "get" : { + "operationId" : "getAllEntities@WorkspaceSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JsonNodeValue;type==SettingTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/page" + }, { + "$ref" : "#/components/parameters/size" + }, { + "$ref" : "#/components/parameters/sort" + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,page,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "page", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get all Setting for Workspaces", + "tags" : [ "Workspaces - Settings", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] + } + }, + "post" : { + "operationId" : "createEntity@WorkspaceSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingPostOptionalIdDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" + "responses" : { + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "tags": [ - "Workspaces - Settings", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "summary" : "Post Settings for Workspaces", + "tags" : [ "Workspaces - Settings", "entities", "workspace-object-controller" ] + } + }, + "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search" : { + "post" : { + "operationId" : "searchEntities@WorkspaceSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "origin", + "required" : false, + "schema" : { + "default" : "ALL", + "description" : "Defines scope of origin of objects. All by default.", + "enum" : [ "ALL", "PARENTS", "NATIVE" ], + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EntitySearchBody" + } + } + }, + "description" : "Search request body with filter, pagination, and sorting options", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingOutList" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingOutList" + } + } + }, + "description" : "Request successfully processed" + } + }, + "tags" : [ "Workspaces - Settings", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}": { - "delete": { - "operationId": "deleteEntity@WorkspaceSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete a Setting for Workspace", - "tags": [ - "Workspaces - Settings", - "entities", - "workspace-object-controller" - ] - }, - "get": { - "operationId": "getEntity@WorkspaceSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get a Setting for Workspace", - "tags": [ - "Workspaces - Settings", - "entities", - "workspace-object-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] + "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}" : { + "delete" : { + "operationId" : "deleteEntity@WorkspaceSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JsonNodeValue;type==SettingTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "$ref" : "#/components/responses/Deleted" + } + }, + "summary" : "Delete a Setting for Workspace", + "tags" : [ "Workspaces - Settings", "entities", "workspace-object-controller" ] + }, + "get" : { + "operationId" : "getEntity@WorkspaceSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JsonNodeValue;type==SettingTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + }, { + "in" : "header", + "name" : "X-GDC-VALIDATE-RELATIONS", + "required" : false, + "schema" : { + "default" : false, + "type" : "boolean" + } + }, { + "description" : "Include Meta objects.", + "example" : "metaInclude=origin,all", + "explode" : false, + "in" : "query", + "name" : "metaInclude", + "required" : false, + "schema" : { + "description" : "Included meta objects", + "items" : { + "enum" : [ "origin", "all", "ALL" ], + "type" : "string" + }, + "type" : "array", + "uniqueItems" : true + }, + "style" : "form" + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + } + }, + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + } + } + }, + "description" : "Request successfully processed" + } + }, + "summary" : "Get a Setting for Workspace", + "tags" : [ "Workspaces - Settings", "entities", "workspace-object-controller" ], + "x-gdc-security-info" : { + "description" : "Contains minimal permission level required to view this object type.", + "permissions" : [ "VIEW" ] } }, - "patch": { - "operationId": "patchEntity@WorkspaceSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "patch" : { + "operationId" : "patchEntity@WorkspaceSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatchDocument" + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JsonNodeValue;type==SettingTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingPatchDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatchDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingPatchDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Patch a Setting for Workspace", - "tags": [ - "Workspaces - Settings", - "entities", - "workspace-object-controller" - ] + "summary" : "Patch a Setting for Workspace", + "tags" : [ "Workspaces - Settings", "entities", "workspace-object-controller" ] }, - "put": { - "operationId": "updateEntity@WorkspaceSettings", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "put" : { + "operationId" : "updateEntity@WorkspaceSettings", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingInDocument" + }, { + "in" : "path", + "name" : "objectId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example" : "content==JsonNodeValue;type==SettingTypeValue", + "in" : "query", + "name" : "filter", + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingInDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingInDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingInDocument" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" + "application/vnd.gooddata.api+json" : { + "schema" : { + "$ref" : "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } } }, - "description": "Request successfully processed" + "description" : "Request successfully processed" } }, - "summary": "Put a Setting for a Workspace", - "tags": [ - "Workspaces - Settings", - "entities", - "workspace-object-controller" - ] + "summary" : "Put a Setting for a Workspace", + "tags" : [ "Workspaces - Settings", "entities", "workspace-object-controller" ] } }, - "/api/v1/layout/customGeoCollections": { - "get": { - "description": "Gets complete layout of custom geo collections.", - "operationId": "getCustomGeoCollectionsLayout", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeCustomGeoCollections" - } - } - }, - "description": "Retrieved layout of all custom geo collections." - } - }, - "summary": "Get all custom geo collections layout", - "tags": [ - "layout", - "Organization - Declarative APIs" - ], - "x-gdc-security-info": { - "description": "Permission required to get custom geo collections layout.", - "permissions": [ - "MANAGE" - ] - } - }, - "put": { - "description": "Sets custom geo collections in organization.", - "operationId": "setCustomGeoCollections", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeCustomGeoCollections" + "/api/v1/layout/customGeoCollections" : { + "get" : { + "description" : "Gets complete layout of custom geo collections.", + "operationId" : "getCustomGeoCollectionsLayout", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeCustomGeoCollections" + } } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "All custom geo collections set." + }, + "description" : "Retrieved layout of all custom geo collections." } }, - "summary": "Set all custom geo collections", - "tags": [ - "layout", - "Organization - Declarative APIs" - ], - "x-gdc-security-info": { - "description": "Permission required to set custom geo collections layout.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/layout/dataSources": { - "get": { - "description": "Retrieve all data sources including related physical model.", - "operationId": "getDataSourcesLayout", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeDataSources" - } - } - }, - "description": "Retrieved all data sources." - } - }, - "summary": "Get all data sources", - "tags": [ - "layout", - "Data Source - Declarative APIs" - ], - "x-gdc-security-info": { - "description": "Permission required to get data sources layout.", - "permissions": [ - "MANAGE" - ] + "summary" : "Get all custom geo collections layout", + "tags" : [ "layout", "Organization - Declarative APIs" ], + "x-gdc-security-info" : { + "description" : "Permission required to get custom geo collections layout.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "Set all data sources including related physical model.", - "operationId": "putDataSourcesLayout", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeDataSources" + "put" : { + "description" : "Sets custom geo collections in organization.", + "operationId" : "setCustomGeoCollections", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeCustomGeoCollections" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "Defined all data sources." + "responses" : { + "204" : { + "description" : "All custom geo collections set." } }, - "summary": "Put all data sources", - "tags": [ - "layout", - "Data Source - Declarative APIs" - ], - "x-gdc-security-info": { - "description": "Permission required to set data sources layout.", - "permissions": [ - "MANAGE" - ] + "summary" : "Set all custom geo collections", + "tags" : [ "layout", "Organization - Declarative APIs" ], + "x-gdc-security-info" : { + "description" : "Permission required to set custom geo collections layout.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/dataSources/{dataSourceId}/permissions": { - "get": { - "description": "Retrieve current set of permissions of the data source in a declarative form.", - "operationId": "getDataSourcePermissions", - "parameters": [ - { - "in": "path", - "name": "dataSourceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeDataSourcePermissions" + "/api/v1/layout/dataSources" : { + "get" : { + "description" : "Retrieve all data sources including related physical model.", + "operationId" : "getDataSourcesLayout", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeDataSources" } } }, - "description": "Retrieved current set of permissions." + "description" : "Retrieved all data sources." } }, - "summary": "Get permissions for the data source", - "tags": [ - "layout", - "Manage Permissions" - ], - "x-gdc-security-info": { - "description": "Permissions required to manipulate permissions.", - "permissions": [ - "MANAGE" - ] + "summary" : "Get all data sources", + "tags" : [ "layout", "Data Source - Declarative APIs" ], + "x-gdc-security-info" : { + "description" : "Permission required to get data sources layout.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "set data source permissions.", - "operationId": "setDataSourcePermissions", - "parameters": [ - { - "in": "path", - "name": "dataSourceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeDataSourcePermissions" + "put" : { + "description" : "Set all data sources including related physical model.", + "operationId" : "putDataSourcesLayout", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeDataSources" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "No Content" + "responses" : { + "204" : { + "description" : "Defined all data sources." } }, - "summary": "Set data source permissions.", - "tags": [ - "layout", - "Manage Permissions" - ], - "x-gdc-security-info": { - "description": "Permissions to modify the user data filters.", - "permissions": [ - "MANAGE" - ] + "summary" : "Put all data sources", + "tags" : [ "layout", "Data Source - Declarative APIs" ], + "x-gdc-security-info" : { + "description" : "Permission required to set data sources layout.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/exportTemplates": { - "get": { - "description": "Gets complete layout of export templates.", - "operationId": "getExportTemplatesLayout", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeExportTemplates" - } - } - }, - "description": "Retrieved layout of all export templates." - } - }, - "summary": "Get all export templates layout", - "tags": [ - "layout", - "Notification Channels" - ], - "x-gdc-security-info": { - "description": "Permission required to get export templates layout.", - "permissions": [ - "MANAGE" - ] + "/api/v1/layout/dataSources/{dataSourceId}/permissions" : { + "get" : { + "description" : "Retrieve current set of permissions of the data source in a declarative form.", + "operationId" : "getDataSourcePermissions", + "parameters" : [ { + "in" : "path", + "name" : "dataSourceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeDataSourcePermissions" + } + } + }, + "description" : "Retrieved current set of permissions." + } + }, + "summary" : "Get permissions for the data source", + "tags" : [ "layout", "Manage Permissions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to manipulate permissions.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "Sets export templates in organization.", - "operationId": "setExportTemplates", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeExportTemplates" + "put" : { + "description" : "set data source permissions.", + "operationId" : "setDataSourcePermissions", + "parameters" : [ { + "in" : "path", + "name" : "dataSourceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeDataSourcePermissions" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "All export templates set." + "responses" : { + "204" : { + "description" : "No Content" } }, - "summary": "Set all export templates", - "tags": [ - "layout", - "Notification Channels" - ], - "x-gdc-security-info": { - "description": "Permission required to set export templates layout.", - "permissions": [ - "MANAGE" - ] + "summary" : "Set data source permissions.", + "tags" : [ "layout", "Manage Permissions" ], + "x-gdc-security-info" : { + "description" : "Permissions to modify the user data filters.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/identityProviders": { - "get": { - "description": "Gets complete layout of identity providers.", - "operationId": "getIdentityProvidersLayout", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/DeclarativeIdentityProvider" - }, - "type": "array" + "/api/v1/layout/exportTemplates" : { + "get" : { + "description" : "Gets complete layout of export templates.", + "operationId" : "getExportTemplatesLayout", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeExportTemplates" } } }, - "description": "Retrieved layout of all identity providers." + "description" : "Retrieved layout of all export templates." } }, - "summary": "Get all identity providers layout", - "tags": [ - "layout", - "Identity Providers" - ], - "x-gdc-security-info": { - "description": "Permission required to get identity providers layout.", - "permissions": [ - "MANAGE" - ] + "summary" : "Get all export templates layout", + "tags" : [ "layout", "Notification Channels" ], + "x-gdc-security-info" : { + "description" : "Permission required to get export templates layout.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "Sets identity providers in organization.", - "operationId": "setIdentityProviders", - "requestBody": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/DeclarativeIdentityProvider" - }, - "type": "array" + "put" : { + "description" : "Sets export templates in organization.", + "operationId" : "setExportTemplates", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeExportTemplates" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "All identity providers set." + "responses" : { + "204" : { + "description" : "All export templates set." } }, - "summary": "Set all identity providers", - "tags": [ - "layout", - "Identity Providers" - ], - "x-gdc-security-info": { - "description": "Permission required to set identity providers layout.", - "permissions": [ - "MANAGE" - ] + "summary" : "Set all export templates", + "tags" : [ "layout", "Notification Channels" ], + "x-gdc-security-info" : { + "description" : "Permission required to set export templates layout.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/notificationChannels": { - "get": { - "description": "Gets complete layout of notification channels.", - "operationId": "getNotificationChannelsLayout", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeNotificationChannels" - } - } - }, - "description": "Retrieved layout of all notification channels." - } - }, - "summary": "Get all notification channels layout", - "tags": [ - "layout", - "Notification Channels" - ], - "x-gdc-security-info": { - "description": "Permission required to get notification channels layout.", - "permissions": [ - "MANAGE" - ] + "/api/v1/layout/identityProviders" : { + "get" : { + "description" : "Gets complete layout of identity providers.", + "operationId" : "getIdentityProvidersLayout", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeIdentityProvider" + }, + "type" : "array" + } + } + }, + "description" : "Retrieved layout of all identity providers." + } + }, + "summary" : "Get all identity providers layout", + "tags" : [ "layout", "Identity Providers" ], + "x-gdc-security-info" : { + "description" : "Permission required to get identity providers layout.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "Sets notification channels in organization.", - "operationId": "setNotificationChannels", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeNotificationChannels" + "put" : { + "description" : "Sets identity providers in organization.", + "operationId" : "setIdentityProviders", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeIdentityProvider" + }, + "type" : "array" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "All notification channels set." + "responses" : { + "204" : { + "description" : "All identity providers set." } }, - "summary": "Set all notification channels", - "tags": [ - "layout", - "Notification Channels" - ], - "x-gdc-security-info": { - "description": "Permission required to set data filters layout.", - "permissions": [ - "MANAGE" - ] + "summary" : "Set all identity providers", + "tags" : [ "layout", "Identity Providers" ], + "x-gdc-security-info" : { + "description" : "Permission required to set identity providers layout.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/organization": { - "get": { - "description": "Retrieve complete layout of organization, workspaces, user-groups, etc.", - "operationId": "getOrganizationLayout", - "parameters": [ - { - "in": "query", - "name": "exclude", - "required": false, - "schema": { - "items": { - "description": "Defines properties which should not be included in the payload.", - "enum": [ - "ACTIVITY_INFO" - ], - "type": "string" - }, - "type": "array" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeOrganization" + "/api/v1/layout/notificationChannels" : { + "get" : { + "description" : "Gets complete layout of notification channels.", + "operationId" : "getNotificationChannelsLayout", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeNotificationChannels" } } }, - "description": "Retrieved all parts of an organization." + "description" : "Retrieved layout of all notification channels." } }, - "summary": "Get organization layout", - "tags": [ - "layout", - "Organization - Declarative APIs" - ], - "x-gdc-security-info": { - "description": "Permission required to get organization layout.", - "permissions": [ - "MANAGE" - ] + "summary" : "Get all notification channels layout", + "tags" : [ "layout", "Notification Channels" ], + "x-gdc-security-info" : { + "description" : "Permission required to get notification channels layout.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "Sets complete layout of organization, like workspaces, user-groups, etc.", - "operationId": "setOrganizationLayout", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeOrganization" + "put" : { + "description" : "Sets notification channels in organization.", + "operationId" : "setNotificationChannels", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeNotificationChannels" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "Defined all parts of an organization." + "responses" : { + "204" : { + "description" : "All notification channels set." } }, - "summary": "Set organization layout", - "tags": [ - "layout", - "Organization - Declarative APIs" - ], - "x-gdc-security-info": { - "description": "Permission required to set organization layout.", - "permissions": [ - "MANAGE" - ] + "summary" : "Set all notification channels", + "tags" : [ "layout", "Notification Channels" ], + "x-gdc-security-info" : { + "description" : "Permission required to set data filters layout.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/organization/permissions": { - "get": { - "description": "Retrieve organization permissions", - "operationId": "getOrganizationPermissions", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/DeclarativeOrganizationPermission" - }, - "type": "array" - } - } - }, - "description": "Retrieved all organization permissions." - } - }, - "summary": "Get organization permissions", - "tags": [ - "layout", - "Permissions" - ], - "x-gdc-security-info": { - "description": "Permission required to get organization permissions.", - "permissions": [ - "MANAGE" - ] + "/api/v1/layout/organization" : { + "get" : { + "description" : "Retrieve complete layout of organization, workspaces, user-groups, etc.", + "operationId" : "getOrganizationLayout", + "parameters" : [ { + "in" : "query", + "name" : "exclude", + "required" : false, + "schema" : { + "items" : { + "description" : "Defines properties which should not be included in the payload.", + "enum" : [ "ACTIVITY_INFO" ], + "type" : "string" + }, + "type" : "array" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeOrganization" + } + } + }, + "description" : "Retrieved all parts of an organization." + } + }, + "summary" : "Get organization layout", + "tags" : [ "layout", "Organization - Declarative APIs" ], + "x-gdc-security-info" : { + "description" : "Permission required to get organization layout.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "Sets organization permissions", - "operationId": "setOrganizationPermissions", - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "An array of declarative organization permissions assignments", - "items": { - "$ref": "#/components/schemas/DeclarativeOrganizationPermission" - }, - "type": "array" + "put" : { + "description" : "Sets complete layout of organization, like workspaces, user-groups, etc.", + "operationId" : "setOrganizationLayout", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeOrganization" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "Organization permissions set." + "responses" : { + "204" : { + "description" : "Defined all parts of an organization." } }, - "summary": "Set organization permissions", - "tags": [ - "layout", - "Permissions" - ], - "x-gdc-security-info": { - "description": "Permission required to set organization permissions.", - "permissions": [ - "MANAGE" - ] + "summary" : "Set organization layout", + "tags" : [ "layout", "Organization - Declarative APIs" ], + "x-gdc-security-info" : { + "description" : "Permission required to set organization layout.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/userGroups": { - "get": { - "description": "Retrieve all user-groups eventually with parent group.", - "operationId": "getUserGroupsLayout", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeUserGroups" - } - } - }, - "description": "Retrieved all user groups." - } - }, - "summary": "Get all user groups", - "tags": [ - "layout", - "UserGroups - Declarative APIs" - ], - "x-gdc-security-info": { - "description": "Permission required to get groups layout.", - "permissions": [ - "MANAGE" - ] + "/api/v1/layout/organization/permissions" : { + "get" : { + "description" : "Retrieve organization permissions", + "operationId" : "getOrganizationPermissions", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeOrganizationPermission" + }, + "type" : "array" + } + } + }, + "description" : "Retrieved all organization permissions." + } + }, + "summary" : "Get organization permissions", + "tags" : [ "layout", "Permissions" ], + "x-gdc-security-info" : { + "description" : "Permission required to get organization permissions.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "Define all user groups with their parents eventually.", - "operationId": "putUserGroupsLayout", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeUserGroups" + "put" : { + "description" : "Sets organization permissions", + "operationId" : "setOrganizationPermissions", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "description" : "An array of declarative organization permissions assignments", + "items" : { + "$ref" : "#/components/schemas/DeclarativeOrganizationPermission" + }, + "type" : "array" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "Defined all user groups." + "responses" : { + "204" : { + "description" : "Organization permissions set." } }, - "summary": "Put all user groups", - "tags": [ - "layout", - "UserGroups - Declarative APIs" - ], - "x-gdc-security-info": { - "description": "Permission required to set groups layout.", - "permissions": [ - "MANAGE" - ] + "summary" : "Set organization permissions", + "tags" : [ "layout", "Permissions" ], + "x-gdc-security-info" : { + "description" : "Permission required to set organization permissions.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/userGroups/{userGroupId}/permissions": { - "get": { - "description": "Retrieve current set of permissions of the user-group in a declarative form.", - "operationId": "getUserGroupPermissions", - "parameters": [ - { - "in": "path", - "name": "userGroupId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeUserGroupPermissions" + "/api/v1/layout/userGroups" : { + "get" : { + "description" : "Retrieve all user-groups eventually with parent group.", + "operationId" : "getUserGroupsLayout", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeUserGroups" } } }, - "description": "Retrieved current set of permissions." + "description" : "Retrieved all user groups." } }, - "summary": "Get permissions for the user-group", - "tags": [ - "layout", - "Permissions" - ], - "x-gdc-security-info": { - "description": "Permissions required to manipulate permissions.", - "permissions": [ - "MANAGE" - ] + "summary" : "Get all user groups", + "tags" : [ "layout", "UserGroups - Declarative APIs" ], + "x-gdc-security-info" : { + "description" : "Permission required to get groups layout.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "Set effective permissions for the user-group", - "operationId": "setUserGroupPermissions", - "parameters": [ - { - "in": "path", - "name": "userGroupId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeUserGroupPermissions" + "put" : { + "description" : "Define all user groups with their parents eventually.", + "operationId" : "putUserGroupsLayout", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeUserGroups" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "User-group permissions successfully set." + "responses" : { + "204" : { + "description" : "Defined all user groups." } }, - "summary": "Set permissions for the user-group", - "tags": [ - "layout", - "Permissions" - ], - "x-gdc-security-info": { - "description": "Permissions required to manipulate permissions.", - "permissions": [ - "MANAGE" - ] + "summary" : "Put all user groups", + "tags" : [ "layout", "UserGroups - Declarative APIs" ], + "x-gdc-security-info" : { + "description" : "Permission required to set groups layout.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/users": { - "get": { - "description": "Retrieve all users including authentication properties.", - "operationId": "getUsersLayout", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeUsers" - } - } - }, - "description": "Retrieved all users." - } - }, - "summary": "Get all users", - "tags": [ - "layout", - "Users - Declarative APIs" - ], - "x-gdc-security-info": { - "description": "Permission required to get users layout.", - "permissions": [ - "MANAGE" - ] + "/api/v1/layout/userGroups/{userGroupId}/permissions" : { + "get" : { + "description" : "Retrieve current set of permissions of the user-group in a declarative form.", + "operationId" : "getUserGroupPermissions", + "parameters" : [ { + "in" : "path", + "name" : "userGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeUserGroupPermissions" + } + } + }, + "description" : "Retrieved current set of permissions." + } + }, + "summary" : "Get permissions for the user-group", + "tags" : [ "layout", "Permissions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to manipulate permissions.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "Set all users and their authentication properties.", - "operationId": "putUsersLayout", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeUsers" + "put" : { + "description" : "Set effective permissions for the user-group", + "operationId" : "setUserGroupPermissions", + "parameters" : [ { + "in" : "path", + "name" : "userGroupId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeUserGroupPermissions" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "Defined all users." + "responses" : { + "204" : { + "description" : "User-group permissions successfully set." } }, - "summary": "Put all users", - "tags": [ - "layout", - "Users - Declarative APIs" - ], - "x-gdc-security-info": { - "description": "Permission required to set users layout.", - "permissions": [ - "MANAGE" - ] + "summary" : "Set permissions for the user-group", + "tags" : [ "layout", "Permissions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to manipulate permissions.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/users/{userId}/permissions": { - "get": { - "description": "Retrieve current set of permissions of the user in a declarative form.", - "operationId": "getUserPermissions", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeUserPermissions" + "/api/v1/layout/users" : { + "get" : { + "description" : "Retrieve all users including authentication properties.", + "operationId" : "getUsersLayout", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeUsers" } } }, - "description": "Retrieved current set of permissions." + "description" : "Retrieved all users." } }, - "summary": "Get permissions for the user", - "tags": [ - "layout", - "Permissions" - ], - "x-gdc-security-info": { - "description": "Permissions required to manipulate permissions.", - "permissions": [ - "MANAGE" - ] + "summary" : "Get all users", + "tags" : [ "layout", "Users - Declarative APIs" ], + "x-gdc-security-info" : { + "description" : "Permission required to get users layout.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "Set effective permissions for the user", - "operationId": "setUserPermissions", - "parameters": [ - { - "in": "path", - "name": "userId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeUserPermissions" + "put" : { + "description" : "Set all users and their authentication properties.", + "operationId" : "putUsersLayout", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeUsers" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "User permissions successfully set." + "responses" : { + "204" : { + "description" : "Defined all users." } }, - "summary": "Set permissions for the user", - "tags": [ - "layout", - "Permissions" - ], - "x-gdc-security-info": { - "description": "Permissions required to manipulate permissions.", - "permissions": [ - "MANAGE" - ] + "summary" : "Put all users", + "tags" : [ "layout", "Users - Declarative APIs" ], + "x-gdc-security-info" : { + "description" : "Permission required to set users layout.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/usersAndUserGroups": { - "get": { - "description": "Retrieve all users and user groups with theirs properties.", - "operationId": "getUsersUserGroupsLayout", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeUsersUserGroups" - } - } - }, - "description": "Retrieved all users and user groups." - } - }, - "summary": "Get all users and user groups", - "tags": [ - "layout", - "UserGroups - Declarative APIs" - ], - "x-gdc-security-info": { - "description": "Permission required to get user/groups layout.", - "permissions": [ - "MANAGE" - ] + "/api/v1/layout/users/{userId}/permissions" : { + "get" : { + "description" : "Retrieve current set of permissions of the user in a declarative form.", + "operationId" : "getUserPermissions", + "parameters" : [ { + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeUserPermissions" + } + } + }, + "description" : "Retrieved current set of permissions." + } + }, + "summary" : "Get permissions for the user", + "tags" : [ "layout", "Permissions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to manipulate permissions.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "Define all users and user groups with theirs properties.", - "operationId": "putUsersUserGroupsLayout", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeUsersUserGroups" + "put" : { + "description" : "Set effective permissions for the user", + "operationId" : "setUserPermissions", + "parameters" : [ { + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeUserPermissions" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "Defined all users and user groups." + "responses" : { + "204" : { + "description" : "User permissions successfully set." } }, - "summary": "Put all users and user groups", - "tags": [ - "layout", - "UserGroups - Declarative APIs" - ], - "x-gdc-security-info": { - "description": "Permission required to set user/groups layout.", - "permissions": [ - "MANAGE" - ] + "summary" : "Set permissions for the user", + "tags" : [ "layout", "Permissions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to manipulate permissions.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/workspaceDataFilters": { - "get": { - "description": "Retrieve all workspaces and related workspace data filters (and their settings / values).", - "operationId": "getWorkspaceDataFiltersLayout", - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilters" - } - } - }, - "description": "Retrieved all workspace data filters." - } - }, - "summary": "Get workspace data filters for all workspaces", - "tags": [ - "layout", - "Data Filters" - ], - "x-gdc-security-info": { - "description": "Permission required to get data filters layout.", - "permissions": [ - "MANAGE" - ] + "/api/v1/layout/usersAndUserGroups" : { + "get" : { + "description" : "Retrieve all users and user groups with theirs properties.", + "operationId" : "getUsersUserGroupsLayout", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeUsersUserGroups" + } + } + }, + "description" : "Retrieved all users and user groups." + } + }, + "summary" : "Get all users and user groups", + "tags" : [ "layout", "UserGroups - Declarative APIs" ], + "x-gdc-security-info" : { + "description" : "Permission required to get user/groups layout.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "Sets workspace data filters in all workspaces in entire organization.", - "operationId": "setWorkspaceDataFiltersLayout", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilters" + "put" : { + "description" : "Define all users and user groups with theirs properties.", + "operationId" : "putUsersUserGroupsLayout", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeUsersUserGroups" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "All workspace data filters set." + "responses" : { + "204" : { + "description" : "Defined all users and user groups." } }, - "summary": "Set all workspace data filters", - "tags": [ - "layout", - "Data Filters" - ], - "x-gdc-security-info": { - "description": "Permission required to set data filters layout.", - "permissions": [ - "MANAGE" - ] + "summary" : "Put all users and user groups", + "tags" : [ "layout", "UserGroups - Declarative APIs" ], + "x-gdc-security-info" : { + "description" : "Permission required to set user/groups layout.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/workspaces": { - "get": { - "description": "Gets complete layout of workspaces, their hierarchy, models.", - "operationId": "getWorkspacesLayout", - "parameters": [ - { - "in": "query", - "name": "exclude", - "required": false, - "schema": { - "items": { - "description": "Defines properties which should not be included in the payload.", - "enum": [ - "ACTIVITY_INFO" - ], - "type": "string" - }, - "type": "array" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeWorkspaces" + "/api/v1/layout/workspaceDataFilters" : { + "get" : { + "description" : "Retrieve all workspaces and related workspace data filters (and their settings / values).", + "operationId" : "getWorkspaceDataFiltersLayout", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeWorkspaceDataFilters" } } }, - "description": "Retrieved layout of all workspaces." + "description" : "Retrieved all workspace data filters." } }, - "summary": "Get all workspaces layout", - "tags": [ - "layout", - "Workspaces - Declarative APIs" - ], - "x-gdc-security-info": { - "description": "Permission required to get workspaces layout.", - "permissions": [ - "MANAGE" - ] + "summary" : "Get workspace data filters for all workspaces", + "tags" : [ "layout", "Data Filters" ], + "x-gdc-security-info" : { + "description" : "Permission required to get data filters layout.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "Sets complete layout of workspaces, their hierarchy, models.", - "operationId": "setWorkspacesLayout", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeWorkspaces" + "put" : { + "description" : "Sets workspace data filters in all workspaces in entire organization.", + "operationId" : "setWorkspaceDataFiltersLayout", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeWorkspaceDataFilters" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "All workspaces layout set." + "responses" : { + "204" : { + "description" : "All workspace data filters set." } }, - "summary": "Set all workspaces layout", - "tags": [ - "layout", - "Workspaces - Declarative APIs" - ], - "x-gdc-security-info": { - "description": "Permission required to set workspaces layout.", - "permissions": [ - "MANAGE" - ] + "summary" : "Set all workspace data filters", + "tags" : [ "layout", "Data Filters" ], + "x-gdc-security-info" : { + "description" : "Permission required to set data filters layout.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/workspaces/{workspaceId}": { - "get": { - "description": "Retrieve current model of the workspace in declarative form.", - "operationId": "getWorkspaceLayout", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" + "/api/v1/layout/workspaces" : { + "get" : { + "description" : "Gets complete layout of workspaces, their hierarchy, models.", + "operationId" : "getWorkspacesLayout", + "parameters" : [ { + "in" : "query", + "name" : "exclude", + "required" : false, + "schema" : { + "items" : { + "description" : "Defines properties which should not be included in the payload.", + "enum" : [ "ACTIVITY_INFO" ], + "type" : "string" + }, + "type" : "array" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeWorkspaces" + } + } + }, + "description" : "Retrieved layout of all workspaces." + } + }, + "summary" : "Get all workspaces layout", + "tags" : [ "layout", "Workspaces - Declarative APIs" ], + "x-gdc-security-info" : { + "description" : "Permission required to get workspaces layout.", + "permissions" : [ "MANAGE" ] + } + }, + "put" : { + "description" : "Sets complete layout of workspaces, their hierarchy, models.", + "operationId" : "setWorkspacesLayout", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeWorkspaces" + } } }, - { - "in": "query", - "name": "exclude", - "required": false, - "schema": { - "items": { - "description": "Defines properties which should not be included in the payload.", - "enum": [ - "ACTIVITY_INFO" - ], - "type": "string" - }, - "type": "array" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeWorkspaceModel" - } - } - }, - "description": "Retrieved the workspace model." + "required" : true + }, + "responses" : { + "204" : { + "description" : "All workspaces layout set." } }, - "summary": "Get workspace layout", - "tags": [ - "layout", - "Workspaces - Declarative APIs" - ], - "x-gdc-security-info": { - "description": "Permissions required to read the layout.", - "permissions": [ - "ANALYZE" - ] + "summary" : "Set all workspaces layout", + "tags" : [ "layout", "Workspaces - Declarative APIs" ], + "x-gdc-security-info" : { + "description" : "Permission required to set workspaces layout.", + "permissions" : [ "MANAGE" ] + } + } + }, + "/api/v1/layout/workspaces/{workspaceId}" : { + "get" : { + "description" : "Retrieve current model of the workspace in declarative form.", + "operationId" : "getWorkspaceLayout", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "exclude", + "required" : false, + "schema" : { + "items" : { + "description" : "Defines properties which should not be included in the payload.", + "enum" : [ "ACTIVITY_INFO" ], + "type" : "string" + }, + "type" : "array" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeWorkspaceModel" + } + } + }, + "description" : "Retrieved the workspace model." + } + }, + "summary" : "Get workspace layout", + "tags" : [ "layout", "Workspaces - Declarative APIs" ], + "x-gdc-security-info" : { + "description" : "Permissions required to read the layout.", + "permissions" : [ "ANALYZE" ] } }, - "put": { - "description": "Set complete layout of workspace, like model, authorization, etc.", - "operationId": "putWorkspaceLayout", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "put" : { + "description" : "Set complete layout of workspace, like model, authorization, etc.", + "operationId" : "putWorkspaceLayout", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeWorkspaceModel" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeWorkspaceModel" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "The model of the workspace was set." + "responses" : { + "204" : { + "description" : "The model of the workspace was set." } }, - "summary": "Set workspace layout", - "tags": [ - "layout", - "Workspaces - Declarative APIs" - ], - "x-gdc-security-info": { - "description": "Permissions required to modify the layout.", - "permissions": [ - "MANAGE" - ] + "summary" : "Set workspace layout", + "tags" : [ "layout", "Workspaces - Declarative APIs" ], + "x-gdc-security-info" : { + "description" : "Permissions required to modify the layout.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/workspaces/{workspaceId}/analyticsModel": { - "get": { - "description": "Retrieve current analytics model of the workspace.", - "operationId": "getAnalyticsModel", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "exclude", - "required": false, - "schema": { - "items": { - "description": "Defines properties which should not be included in the payload.", - "enum": [ - "ACTIVITY_INFO" - ], - "type": "string" - }, - "type": "array" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeAnalytics" - } - } - }, - "description": "Retrieved current analytics model." - } - }, - "summary": "Get analytics model", - "tags": [ - "layout", - "Analytics Model" - ], - "x-gdc-security-info": { - "description": "Permissions to read the analytics layout.", - "permissions": [ - "ANALYZE" - ] + "/api/v1/layout/workspaces/{workspaceId}/analyticsModel" : { + "get" : { + "description" : "Retrieve current analytics model of the workspace.", + "operationId" : "getAnalyticsModel", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "exclude", + "required" : false, + "schema" : { + "items" : { + "description" : "Defines properties which should not be included in the payload.", + "enum" : [ "ACTIVITY_INFO" ], + "type" : "string" + }, + "type" : "array" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeAnalytics" + } + } + }, + "description" : "Retrieved current analytics model." + } + }, + "summary" : "Get analytics model", + "tags" : [ "layout", "Analytics Model" ], + "x-gdc-security-info" : { + "description" : "Permissions to read the analytics layout.", + "permissions" : [ "ANALYZE" ] } }, - "put": { - "description": "Set effective analytics model of the workspace.", - "operationId": "setAnalyticsModel", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "put" : { + "description" : "Set effective analytics model of the workspace.", + "operationId" : "setAnalyticsModel", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeAnalytics" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeAnalytics" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "Analytics model successfully set." + "responses" : { + "204" : { + "description" : "Analytics model successfully set." } }, - "summary": "Set analytics model", - "tags": [ - "layout", - "Analytics Model" - ], - "x-gdc-security-info": { - "description": "Permissions to modify the analytics layout.", - "permissions": [ - "ANALYZE" - ] + "summary" : "Set analytics model", + "tags" : [ "layout", "Analytics Model" ], + "x-gdc-security-info" : { + "description" : "Permissions to modify the analytics layout.", + "permissions" : [ "ANALYZE" ] } } }, - "/api/v1/layout/workspaces/{workspaceId}/automations": { - "get": { - "description": "Retrieve automations for the specific workspace", - "operationId": "getAutomations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "exclude", - "required": false, - "schema": { - "items": { - "description": "Defines properties which should not be included in the payload.", - "enum": [ - "ACTIVITY_INFO" - ], - "type": "string" - }, - "type": "array" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/DeclarativeAutomation" + "/api/v1/layout/workspaces/{workspaceId}/automations" : { + "get" : { + "description" : "Retrieve automations for the specific workspace", + "operationId" : "getAutomations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "exclude", + "required" : false, + "schema" : { + "items" : { + "description" : "Defines properties which should not be included in the payload.", + "enum" : [ "ACTIVITY_INFO" ], + "type" : "string" + }, + "type" : "array" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeAutomation" }, - "type": "array" + "type" : "array" } } }, - "description": "Retrieved automations." + "description" : "Retrieved automations." } }, - "summary": "Get automations", - "tags": [ - "layout", - "Automations" - ], - "x-gdc-security-info": { - "description": "Permissions to read the automations.", - "permissions": [ - "MANAGE" - ] + "summary" : "Get automations", + "tags" : [ "layout", "Automations" ], + "x-gdc-security-info" : { + "description" : "Permissions to read the automations.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "Set automations for the specific workspace.", - "operationId": "setAutomations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "put" : { + "description" : "Set automations for the specific workspace.", + "operationId" : "setAutomations", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/DeclarativeAutomation" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeAutomation" }, - "type": "array" + "type" : "array" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "Automations successfully set." + "responses" : { + "204" : { + "description" : "Automations successfully set." } }, - "summary": "Set automations", - "tags": [ - "layout", - "Automations" - ], - "x-gdc-security-info": { - "description": "Permissions to modify the automations.", - "permissions": [ - "MANAGE" - ] + "summary" : "Set automations", + "tags" : [ "layout", "Automations" ], + "x-gdc-security-info" : { + "description" : "Permissions to modify the automations.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/workspaces/{workspaceId}/filterViews": { - "get": { - "description": "Retrieve filter views for the specific workspace", - "operationId": "getFilterViews", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "exclude", - "required": false, - "schema": { - "items": { - "description": "Defines properties which should not be included in the payload.", - "enum": [ - "ACTIVITY_INFO" - ], - "type": "string" - }, - "type": "array" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/DeclarativeFilterView" + "/api/v1/layout/workspaces/{workspaceId}/filterViews" : { + "get" : { + "description" : "Retrieve filter views for the specific workspace", + "operationId" : "getFilterViews", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "exclude", + "required" : false, + "schema" : { + "items" : { + "description" : "Defines properties which should not be included in the payload.", + "enum" : [ "ACTIVITY_INFO" ], + "type" : "string" + }, + "type" : "array" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeFilterView" }, - "type": "array" + "type" : "array" } } }, - "description": "Retrieved filterViews." + "description" : "Retrieved filterViews." } }, - "summary": "Get filter views", - "tags": [ - "layout", - "Filter Views" - ], - "x-gdc-security-info": { - "description": "Permissions to read the filter views.", - "permissions": [ - "MANAGE" - ] + "summary" : "Get filter views", + "tags" : [ "layout", "Filter Views" ], + "x-gdc-security-info" : { + "description" : "Permissions to read the filter views.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "Set filter views for the specific workspace.", - "operationId": "setFilterViews", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "put" : { + "description" : "Set filter views for the specific workspace.", + "operationId" : "setFilterViews", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/DeclarativeFilterView" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/DeclarativeFilterView" }, - "type": "array" + "type" : "array" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "FilterViews successfully set." + "responses" : { + "204" : { + "description" : "FilterViews successfully set." } }, - "summary": "Set filter views", - "tags": [ - "layout", - "Filter Views" - ], - "x-gdc-security-info": { - "description": "Permissions to modify the filter views.", - "permissions": [ - "MANAGE" - ] + "summary" : "Set filter views", + "tags" : [ "layout", "Filter Views" ], + "x-gdc-security-info" : { + "description" : "Permissions to modify the filter views.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/workspaces/{workspaceId}/logicalModel": { - "get": { - "description": "Retrieve current logical model of the workspace in declarative form.", - "operationId": "getLogicalModel", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "includeParents", - "required": false, - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeModel" - } - } - }, - "description": "Retrieved current logical model." - } - }, - "summary": "Get logical model", - "tags": [ - "LDM - Declarative APIs", - "layout" - ], - "x-gdc-security-info": { - "description": "Permissions required to read the logical model.", - "permissions": [ - "ANALYZE" - ] + "/api/v1/layout/workspaces/{workspaceId}/logicalModel" : { + "get" : { + "description" : "Retrieve current logical model of the workspace in declarative form.", + "operationId" : "getLogicalModel", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "in" : "query", + "name" : "includeParents", + "required" : false, + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeModel" + } + } + }, + "description" : "Retrieved current logical model." + } + }, + "summary" : "Get logical model", + "tags" : [ "LDM - Declarative APIs", "layout" ], + "x-gdc-security-info" : { + "description" : "Permissions required to read the logical model.", + "permissions" : [ "ANALYZE" ] } }, - "put": { - "description": "Set effective logical model of the workspace.", - "operationId": "setLogicalModel", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "put" : { + "description" : "Set effective logical model of the workspace.", + "operationId" : "setLogicalModel", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeModel" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeModel" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "Logical model successfully set." + "responses" : { + "204" : { + "description" : "Logical model successfully set." } }, - "summary": "Set logical model", - "tags": [ - "LDM - Declarative APIs", - "layout" - ], - "x-gdc-security-info": { - "description": "Permissions required to alter the logical model.", - "permissions": [ - "MANAGE" - ] + "summary" : "Set logical model", + "tags" : [ "LDM - Declarative APIs", "layout" ], + "x-gdc-security-info" : { + "description" : "Permissions required to alter the logical model.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/workspaces/{workspaceId}/permissions": { - "get": { - "description": "Retrieve current set of permissions of the workspace in a declarative form.", - "operationId": "getWorkspacePermissions", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeWorkspacePermissions" - } - } - }, - "description": "Retrieved current set of permissions." - } - }, - "summary": "Get permissions for the workspace", - "tags": [ - "layout", - "Permissions" - ], - "x-gdc-security-info": { - "description": "Permissions required to manipulate permissions.", - "permissions": [ - "MANAGE" - ] + "/api/v1/layout/workspaces/{workspaceId}/permissions" : { + "get" : { + "description" : "Retrieve current set of permissions of the workspace in a declarative form.", + "operationId" : "getWorkspacePermissions", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeWorkspacePermissions" + } + } + }, + "description" : "Retrieved current set of permissions." + } + }, + "summary" : "Get permissions for the workspace", + "tags" : [ "layout", "Permissions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to manipulate permissions.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "Set effective permissions for the workspace", - "operationId": "setWorkspacePermissions", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "put" : { + "description" : "Set effective permissions for the workspace", + "operationId" : "setWorkspacePermissions", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeWorkspacePermissions" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeWorkspacePermissions" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "Workspace permissions successfully set." + "responses" : { + "204" : { + "description" : "Workspace permissions successfully set." } }, - "summary": "Set permissions for the workspace", - "tags": [ - "layout", - "Permissions" - ], - "x-gdc-security-info": { - "description": "Permissions required to manipulate permissions.", - "permissions": [ - "MANAGE" - ] + "summary" : "Set permissions for the workspace", + "tags" : [ "layout", "Permissions" ], + "x-gdc-security-info" : { + "description" : "Permissions required to manipulate permissions.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/layout/workspaces/{workspaceId}/userDataFilters": { - "get": { - "description": "Retrieve current user data filters assigned to the workspace.", - "operationId": "getUserDataFilters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeUserDataFilters" - } - } - }, - "description": "Retrieved current user data filters." - } - }, - "summary": "Get user data filters", - "tags": [ - "layout", - "User Data Filters" - ], - "x-gdc-security-info": { - "description": "Permissions to read the user data filters.", - "permissions": [ - "MANAGE" - ] + "/api/v1/layout/workspaces/{workspaceId}/userDataFilters" : { + "get" : { + "description" : "Retrieve current user data filters assigned to the workspace.", + "operationId" : "getUserDataFilters", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeUserDataFilters" + } + } + }, + "description" : "Retrieved current user data filters." + } + }, + "summary" : "Get user data filters", + "tags" : [ "layout", "User Data Filters" ], + "x-gdc-security-info" : { + "description" : "Permissions to read the user data filters.", + "permissions" : [ "MANAGE" ] } }, - "put": { - "description": "Set user data filters assigned to the workspace.", - "operationId": "setUserDataFilters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "put" : { + "description" : "Set user data filters assigned to the workspace.", + "operationId" : "setUserDataFilters", + "parameters" : [ { + "in" : "path", + "name" : "workspaceId", + "required" : true, + "schema" : { + "type" : "string" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeUserDataFilters" + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DeclarativeUserDataFilters" } } }, - "required": true + "required" : true }, - "responses": { - "204": { - "description": "User data filters successfully set." + "responses" : { + "204" : { + "description" : "User data filters successfully set." } }, - "summary": "Set user data filters", - "tags": [ - "layout", - "User Data Filters" - ], - "x-gdc-security-info": { - "description": "Permissions to modify the user data filters.", - "permissions": [ - "MANAGE" - ] + "summary" : "Set user data filters", + "tags" : [ "layout", "User Data Filters" ], + "x-gdc-security-info" : { + "description" : "Permissions to modify the user data filters.", + "permissions" : [ "MANAGE" ] } } }, - "/api/v1/options": { - "get": { - "description": "Retrieves links for all options for different configurations.", - "operationId": "getAllOptions", - "responses": { - "200": { - "content": { - "application/json": { - "examples": { - "All options": { - "description": "All options", - "value": { - "options": { - "description": "Options resources", - "links": { - "availableDrivers": "/api/v1/options/availableDrivers" + "/api/v1/options" : { + "get" : { + "description" : "Retrieves links for all options for different configurations.", + "operationId" : "getAllOptions", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "All options" : { + "description" : "All options", + "value" : { + "options" : { + "description" : "Options resources", + "links" : { + "availableDrivers" : "/api/v1/options/availableDrivers" } } } } }, - "schema": { - "type": "object" + "schema" : { + "type" : "object" } } }, - "description": "Links for all configuration options." + "description" : "Links for all configuration options." } }, - "summary": "Links for all configuration options", - "tags": [ - "Options", - "entities" - ] + "summary" : "Links for all configuration options", + "tags" : [ "Options", "entities" ] } }, - "/api/v1/options/availableDrivers": { - "get": { - "description": "Retrieves a list of all supported data sources along with information about the used drivers.", - "operationId": "getDataSourceDrivers", - "responses": { - "200": { - "content": { - "application/json": { - "examples": { - "All available drivers": { - "description": "All available drivers", - "value": { - "POSTGRESQL": "org.postgresql.Driver", - "REDSHIFT": "com.amazon.redshift.jdbc42.Driver" + "/api/v1/options/availableDrivers" : { + "get" : { + "description" : "Retrieves a list of all supported data sources along with information about the used drivers.", + "operationId" : "getDataSourceDrivers", + "responses" : { + "200" : { + "content" : { + "application/json" : { + "examples" : { + "All available drivers" : { + "description" : "All available drivers", + "value" : { + "POSTGRESQL" : "org.postgresql.Driver", + "REDSHIFT" : "com.amazon.redshift.jdbc42.Driver" } } }, - "schema": { - "additionalProperties": { - "type": "string" + "schema" : { + "additionalProperties" : { + "type" : "string" }, - "type": "object" + "type" : "object" } } }, - "description": "A list of all available data source drivers." + "description" : "A list of all available data source drivers." } }, - "summary": "Get all available data source drivers", - "tags": [ - "entities", - "Available Drivers" - ] + "summary" : "Get all available data source drivers", + "tags" : [ "entities", "Available Drivers" ] } } }, - "servers": [ - { - "description": "GoodData.CN endpoint", - "url": "/" - } - ], - "tags": [ - { - "description": "| interconnected resources representing application state (JSON:API)", - "name": "entities" - }, - { - "description": "| Analytics as Code APIs - YAML-compatible declarative interface", - "name": "aac" - }, - { - "description": "| all-in-one declarative interface (set [PUT] & read [GET] over JSON)", - "name": "layout" - }, - { - "description": "| execution of some form of computation (RPC over JSON)", - "name": "actions" - }, - { - "description": "Use case APIs for user management", - "name": "User management" - } - ] -} + "servers" : [ { + "description" : "GoodData.CN endpoint", + "url" : "/" + } ], + "tags" : [ { + "description" : "| interconnected resources representing application state (JSON:API)", + "name" : "entities" + }, { + "description" : "| Analytics as Code APIs - YAML-compatible declarative interface", + "name" : "aac" + }, { + "description" : "| all-in-one declarative interface (set [PUT] & read [GET] over JSON)", + "name" : "layout" + }, { + "description" : "| execution of some form of computation (RPC over JSON)", + "name" : "actions" + }, { + "description" : "Use case APIs for user management", + "name" : "User management" + } ] +} \ No newline at end of file