This documentation is for the unstable version of GoodData, currrently in development.
For stable version, go to the latest stable version of this article.
For stable version, go to the latest stable version of this article.
catalog_workspace.
get_declarative_workspace
get_declarative_workspace(workspace_id: str, exclude: Optional[list[str]])
Get all workspaces in the current organization in a declarative form.
This method combines
sdk.catalog_workspace_content.get_declarative_ldm and sdk.catalog_workspace_content.get_declarative_analytics_model
methods and returns a declarative workspace object.
Parameters
| name | type | description |
|---|---|---|
| workspace_id | string | Workspace identification string e.g. "demo" |
| exclude | Optional[list[str]] | Defines properties which should not be included in the payload. E.g.: ["ACTIVITY_INFO"] |
Returns
| type | description |
|---|---|
| CatalogDeclarativeWorkspaces | Declarative Workspaces object including all the workspaces for given organization. |
Example
# Get declarative workspace
declarative_workspace = sdk.catalog_workspace.get_declarative_workspace(workspace_id="123")