IAnalyticalWorkspace
Home > @gooddata/sdk-backend-spi > IAnalyticalWorkspace
IAnalyticalWorkspace interface
Represents an analytical workspace hosted on a backend.
Signature:
export interface IAnalyticalWorkspace
Remarks
It is an entry point to various services that can be used to inspect and modify the workspace and run executions to obtain analytics for the workspace.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| workspace | readonly | string |
Methods
| Method | Description |
|---|---|
| accessControl() | Returns service that can be used to manage access control records for the workspace. |
| attributeHierarchies() | (ALPHA) Returns service that operates over attribute hierarchies |
| attributes() | Returns service that can be used to query additional attributes and attribtue display forms data, and their elements. |
| automations() | (ALPHA) Returns service that can be used to query and update workspace automations. |
| catalog() | Returns factory that can be used to query workspace catalog items - attributes, measures, facts and date data sets. |
| dashboards() | Returns service that can be used to query and update dashboards. |
| dataFilters() | (ALPHA) Returns service that operates over Data Filters. |
| datasets() | Returns service that can be used to query data sets defined in this workspace. |
| dateFilterConfigs() | Returns service that can be used to query date filter configs. |
| execution() | Returns execution factory - which is an entry point to triggering executions and thus obtaining analytics from the workspace. |
| exportDefinitions() | (ALPHA) Returns service that operates over export definitions |
| facts() | Returns service that can be used to query additional facts data. |
| genAI() | (BETA) Returns service that can be used to access GenAI services. |
| getDescriptor(includeParentPrefixes) | Returns details about the analytical workspace. Throws error in case the workspace does not exist. |
| getParentWorkspace() | Returns parent analytical workspace when this workspace has a parent, undefined otherwise. |
| insights() | Returns service that can be used to query and update insights. |
| measures() | Returns service that can be used to query additional measures data. |
| permissions() | Returns service that can be used to query workspace permissions. |
| settings() | Returns service that can be used to obtain settings that are currently in effect for the workspace. |
| styling() | Returns service that can be used to obtain workspace styling settings. These settings specify for instance what colors should be used in the charts. |
| updateDescriptor(descriptor) | Updates the details of the workspace. Throws error in case the workspace does not exist. |
| userGroups() | Returns service that can be used to query workspace user groups. |
| users() | Returns service that can be used to query workspace users. |