|
| 1 | +# gooddata_api_client.AACLogicalDataModelApi |
| 2 | + |
| 3 | +All URIs are relative to *http://localhost* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**get_logical_model_aac**](AACLogicalDataModelApi.md#get_logical_model_aac) | **GET** /api/v1/aac/workspaces/{workspaceId}/logicalModel | Get logical model in AAC format |
| 8 | +[**set_logical_model_aac**](AACLogicalDataModelApi.md#set_logical_model_aac) | **PUT** /api/v1/aac/workspaces/{workspaceId}/logicalModel | Set logical model from AAC format |
| 9 | + |
| 10 | + |
| 11 | +# **get_logical_model_aac** |
| 12 | +> AacLogicalModel get_logical_model_aac(workspace_id) |
| 13 | +
|
| 14 | +Get logical model in AAC format |
| 15 | + |
| 16 | + Retrieve the logical data model of the workspace in Analytics as Code format. The returned format is compatible with the YAML definitions used by the GoodData Analytics as Code VSCode extension. Use this for exporting models that can be directly used as YAML configuration files. |
| 17 | + |
| 18 | +### Example |
| 19 | + |
| 20 | + |
| 21 | +```python |
| 22 | +import time |
| 23 | +import gooddata_api_client |
| 24 | +from gooddata_api_client.api import aac_logical_data_model_api |
| 25 | +from gooddata_api_client.model.aac_logical_model import AacLogicalModel |
| 26 | +from pprint import pprint |
| 27 | +# Defining the host is optional and defaults to http://localhost |
| 28 | +# See configuration.py for a list of all supported configuration parameters. |
| 29 | +configuration = gooddata_api_client.Configuration( |
| 30 | + host = "http://localhost" |
| 31 | +) |
| 32 | + |
| 33 | + |
| 34 | +# Enter a context with an instance of the API client |
| 35 | +with gooddata_api_client.ApiClient() as api_client: |
| 36 | + # Create an instance of the API class |
| 37 | + api_instance = aac_logical_data_model_api.AACLogicalDataModelApi(api_client) |
| 38 | + workspace_id = "workspaceId_example" # str | |
| 39 | + include_parents = True # bool | (optional) |
| 40 | + |
| 41 | + # example passing only required values which don't have defaults set |
| 42 | + try: |
| 43 | + # Get logical model in AAC format |
| 44 | + api_response = api_instance.get_logical_model_aac(workspace_id) |
| 45 | + pprint(api_response) |
| 46 | + except gooddata_api_client.ApiException as e: |
| 47 | + print("Exception when calling AACLogicalDataModelApi->get_logical_model_aac: %s\n" % e) |
| 48 | + |
| 49 | + # example passing only required values which don't have defaults set |
| 50 | + # and optional values |
| 51 | + try: |
| 52 | + # Get logical model in AAC format |
| 53 | + api_response = api_instance.get_logical_model_aac(workspace_id, include_parents=include_parents) |
| 54 | + pprint(api_response) |
| 55 | + except gooddata_api_client.ApiException as e: |
| 56 | + print("Exception when calling AACLogicalDataModelApi->get_logical_model_aac: %s\n" % e) |
| 57 | +``` |
| 58 | + |
| 59 | + |
| 60 | +### Parameters |
| 61 | + |
| 62 | +Name | Type | Description | Notes |
| 63 | +------------- | ------------- | ------------- | ------------- |
| 64 | + **workspace_id** | **str**| | |
| 65 | + **include_parents** | **bool**| | [optional] |
| 66 | + |
| 67 | +### Return type |
| 68 | + |
| 69 | +[**AacLogicalModel**](AacLogicalModel.md) |
| 70 | + |
| 71 | +### Authorization |
| 72 | + |
| 73 | +No authorization required |
| 74 | + |
| 75 | +### HTTP request headers |
| 76 | + |
| 77 | + - **Content-Type**: Not defined |
| 78 | + - **Accept**: application/json |
| 79 | + |
| 80 | + |
| 81 | +### HTTP response details |
| 82 | + |
| 83 | +| Status code | Description | Response headers | |
| 84 | +|-------------|-------------|------------------| |
| 85 | +**200** | Retrieved current logical model in AAC format. | - | |
| 86 | + |
| 87 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 88 | + |
| 89 | +# **set_logical_model_aac** |
| 90 | +> set_logical_model_aac(workspace_id, aac_logical_model) |
| 91 | +
|
| 92 | +Set logical model from AAC format |
| 93 | + |
| 94 | + Set the logical data model of the workspace using Analytics as Code format. The input format is compatible with the YAML definitions used by the GoodData Analytics as Code VSCode extension. This replaces the entire logical model with the provided definition. |
| 95 | + |
| 96 | +### Example |
| 97 | + |
| 98 | + |
| 99 | +```python |
| 100 | +import time |
| 101 | +import gooddata_api_client |
| 102 | +from gooddata_api_client.api import aac_logical_data_model_api |
| 103 | +from gooddata_api_client.model.aac_logical_model import AacLogicalModel |
| 104 | +from pprint import pprint |
| 105 | +# Defining the host is optional and defaults to http://localhost |
| 106 | +# See configuration.py for a list of all supported configuration parameters. |
| 107 | +configuration = gooddata_api_client.Configuration( |
| 108 | + host = "http://localhost" |
| 109 | +) |
| 110 | + |
| 111 | + |
| 112 | +# Enter a context with an instance of the API client |
| 113 | +with gooddata_api_client.ApiClient() as api_client: |
| 114 | + # Create an instance of the API class |
| 115 | + api_instance = aac_logical_data_model_api.AACLogicalDataModelApi(api_client) |
| 116 | + workspace_id = "workspaceId_example" # str | |
| 117 | + aac_logical_model = AacLogicalModel( |
| 118 | + datasets=[ |
| 119 | + AacDataset( |
| 120 | + data_source="my-postgres", |
| 121 | + description="description_example", |
| 122 | + fields={ |
| 123 | + "key": AacField( |
| 124 | + aggregated_as="SUM", |
| 125 | + assigned_to="assigned_to_example", |
| 126 | + data_type="STRING", |
| 127 | + default_view="default_view_example", |
| 128 | + description="description_example", |
| 129 | + is_hidden=True, |
| 130 | + labels={ |
| 131 | + "key": AacLabel( |
| 132 | + data_type="INT", |
| 133 | + description="description_example", |
| 134 | + geo_area_config=AacGeoAreaConfig( |
| 135 | + collection=AacGeoCollectionIdentifier( |
| 136 | + id="id_example", |
| 137 | + kind="STATIC", |
| 138 | + ), |
| 139 | + ), |
| 140 | + is_hidden=True, |
| 141 | + locale="locale_example", |
| 142 | + show_in_ai_results=True, |
| 143 | + source_column="source_column_example", |
| 144 | + tags=[ |
| 145 | + "tags_example", |
| 146 | + ], |
| 147 | + title="title_example", |
| 148 | + translations=[ |
| 149 | + AacLabelTranslation( |
| 150 | + locale="locale_example", |
| 151 | + source_column="source_column_example", |
| 152 | + ), |
| 153 | + ], |
| 154 | + value_type="TEXT", |
| 155 | + ), |
| 156 | + }, |
| 157 | + locale="locale_example", |
| 158 | + show_in_ai_results=True, |
| 159 | + sort_column="sort_column_example", |
| 160 | + sort_direction="ASC", |
| 161 | + source_column="source_column_example", |
| 162 | + tags=[ |
| 163 | + "tags_example", |
| 164 | + ], |
| 165 | + title="title_example", |
| 166 | + type="attribute", |
| 167 | + ), |
| 168 | + }, |
| 169 | + id="customers", |
| 170 | + precedence=1, |
| 171 | + primary_key=AacDatasetPrimaryKey(None), |
| 172 | + references=[ |
| 173 | + AacReference( |
| 174 | + dataset="orders", |
| 175 | + multi_directional=True, |
| 176 | + sources=[ |
| 177 | + AacReferenceSource( |
| 178 | + data_type="INT", |
| 179 | + source_column="source_column_example", |
| 180 | + target="target_example", |
| 181 | + ), |
| 182 | + ], |
| 183 | + ), |
| 184 | + ], |
| 185 | + sql="sql_example", |
| 186 | + table_path="public/customers", |
| 187 | + tags=[ |
| 188 | + "tags_example", |
| 189 | + ], |
| 190 | + title="Customers", |
| 191 | + type="dataset", |
| 192 | + workspace_data_filters=[ |
| 193 | + AacWorkspaceDataFilter( |
| 194 | + data_type="INT", |
| 195 | + filter_id="filter_id_example", |
| 196 | + source_column="source_column_example", |
| 197 | + ), |
| 198 | + ], |
| 199 | + ), |
| 200 | + ], |
| 201 | + date_datasets=[ |
| 202 | + AacDateDataset( |
| 203 | + description="description_example", |
| 204 | + granularities=[ |
| 205 | + "granularities_example", |
| 206 | + ], |
| 207 | + id="date", |
| 208 | + tags=[ |
| 209 | + "tags_example", |
| 210 | + ], |
| 211 | + title="Date", |
| 212 | + title_base="title_base_example", |
| 213 | + title_pattern="title_pattern_example", |
| 214 | + type="date", |
| 215 | + ), |
| 216 | + ], |
| 217 | + ) # AacLogicalModel | |
| 218 | + |
| 219 | + # example passing only required values which don't have defaults set |
| 220 | + try: |
| 221 | + # Set logical model from AAC format |
| 222 | + api_instance.set_logical_model_aac(workspace_id, aac_logical_model) |
| 223 | + except gooddata_api_client.ApiException as e: |
| 224 | + print("Exception when calling AACLogicalDataModelApi->set_logical_model_aac: %s\n" % e) |
| 225 | +``` |
| 226 | + |
| 227 | + |
| 228 | +### Parameters |
| 229 | + |
| 230 | +Name | Type | Description | Notes |
| 231 | +------------- | ------------- | ------------- | ------------- |
| 232 | + **workspace_id** | **str**| | |
| 233 | + **aac_logical_model** | [**AacLogicalModel**](AacLogicalModel.md)| | |
| 234 | + |
| 235 | +### Return type |
| 236 | + |
| 237 | +void (empty response body) |
| 238 | + |
| 239 | +### Authorization |
| 240 | + |
| 241 | +No authorization required |
| 242 | + |
| 243 | +### HTTP request headers |
| 244 | + |
| 245 | + - **Content-Type**: application/json |
| 246 | + - **Accept**: Not defined |
| 247 | + |
| 248 | + |
| 249 | +### HTTP response details |
| 250 | + |
| 251 | +| Status code | Description | Response headers | |
| 252 | +|-------------|-------------|------------------| |
| 253 | +**204** | Logical model successfully set. | - | |
| 254 | + |
| 255 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 256 | + |
0 commit comments