> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown. # IAnalyticalWorkspace - Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md) - Kind: interface - Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/workspace/index.ts Represents an analytical workspace hosted on a backend. **Signature:** ```typescript 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](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspaceworkspace) | `readonly` | string | | ## Methods | Method | Description | | --- | --- | | [accessControl()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspaceaccesscontrol) | Returns service that can be used to manage access control records for the workspace. | | [agents()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspaceagents) | **_(ALPHA)_** Returns service that can be used to query AI agents available in this workspace. | | [attributeHierarchies()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspaceattributehierarchies) | **_(ALPHA)_** Returns service that operates over attribute hierarchies | | [attributes()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspaceattributes) | Returns service that can be used to query additional attributes and attribtue display forms data, and their elements. | | [automations()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspaceautomations) | **_(ALPHA)_** Returns service that can be used to query and update workspace automations. | | [catalog()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacecatalog) | Returns factory that can be used to query workspace catalog items - attributes, measures, facts and date data sets. | | [computedAttributes()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacecomputedattributes) | Returns service that can be used to manage and query computed attributes. | | [customApplicationSettings()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacecustomapplicationsettings) | **_(ALPHA)_** Returns service that manages the settings that applications store in the workspace. | | [dashboards()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacedashboards) | Returns service that can be used to query and update dashboards. | | [dataFilters()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacedatafilters) | **_(ALPHA)_** Returns service that operates over Data Filters. | | [datasets()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacedatasets) | Returns service that can be used to query data sets defined in this workspace. | | [dateFilterConfigs()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacedatefilterconfigs) | Returns service that can be used to query date filter configs. | | [delete()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacedelete) | **_(ALPHA)_** Delete the workspace. | | [execution()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspaceexecution) | Returns execution factory - which is an entry point to triggering executions and thus obtaining analytics from the workspace. | | [exportDefinitions()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspaceexportdefinitions) | **_(ALPHA)_** Returns service that operates over export definitions | | [exportTemplates()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspaceexporttemplates) | **_(BETA)_** Returns service that can be used to query workspace-level export templates for slide exports. | | [facts()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacefacts) | Returns service that can be used to query additional facts data. | | [genAI()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacegenai) | **_(BETA)_** Returns service that can be used to access GenAI services. | | [getDescriptor(includeParentPrefixes)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacegetdescriptor) | Returns details about the analytical workspace. Throws error in case the workspace does not exist. | | [getParentWorkspace()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacegetparentworkspace) | Returns parent analytical workspace when this workspace has a parent, undefined otherwise. | | [insights()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspaceinsights) | Returns service that can be used to query and update insights. | | [keyDriverAnalysis()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacekeydriveranalysis) | Returns service that can be used to work with key drivers. | | [localization()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacelocalization) | **_(ALPHA)_** Returns service that reports how languages and translations are used in the workspace. | | [logicalModel()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacelogicalmodel) | **_(ALPHA)_** Returns service that reads and changes the logical data model. | | [measures()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacemeasures) | Returns service that can be used to query additional measures data. | | [objectPermissions()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspaceobjectpermissions) | **_(ALPHA)_** Returns service that manages per-object access for catalog attributes, facts and labels. | | [parameters()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspaceparameters) | Returns service that can be used to query additional parameters data. | | [permissions()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacepermissions) | Returns service that can be used to query workspace permissions. | | [publisher()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacepublisher) | **_(ALPHA)_** Returns service that can be used to manage page templates, document templates and documents. | | [publisherV2()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacepublisherv2) | **_(ALPHA)_** Returns service that can be used to manage page templates, document templates and documents in content version 2. | | [references()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacereferences) | Returns service that can be used to access references. | | [settings()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacesettings) | Returns service that can be used to obtain settings that are currently in effect for the workspace. | | [styling()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspacestyling) | 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)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspaceupdatedescriptor) | Updates the details of the workspace. Throws error in case the workspace does not exist. | | [userGroups()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspaceusergroups) | Returns service that can be used to query workspace user groups. | | [users()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md#ianalyticalworkspaceusers) | Returns service that can be used to query workspace users. | ## Property details ### IAnalyticalWorkspace.workspace **Signature:** ```typescript readonly workspace: string; ``` ## Method details ### IAnalyticalWorkspace.accessControl() Returns service that can be used to manage access control records for the workspace. **Signature:** ```typescript accessControl(): IWorkspaceAccessControlService; ``` **Returns:** [IWorkspaceAccessControlService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceaccesscontrolservice/index.md) ### IAnalyticalWorkspace.agents() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Returns service that can be used to query AI agents available in this workspace. **Signature:** ```typescript agents(): IWorkspaceAgentsService; ``` **Returns:** [IWorkspaceAgentsService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceagentsservice/index.md) ### IAnalyticalWorkspace.attributeHierarchies() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Returns service that operates over attribute hierarchies **Signature:** ```typescript attributeHierarchies(): IAttributeHierarchiesService; ``` **Returns:** [IAttributeHierarchiesService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iattributehierarchiesservice/index.md) ### IAnalyticalWorkspace.attributes() Returns service that can be used to query additional attributes and attribtue display forms data, and their elements. **Signature:** ```typescript attributes(): IWorkspaceAttributesService; ``` **Returns:** [IWorkspaceAttributesService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceattributesservice/index.md) ### IAnalyticalWorkspace.automations() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Returns service that can be used to query and update workspace automations. **Signature:** ```typescript automations(): IWorkspaceAutomationService; ``` **Returns:** [IWorkspaceAutomationService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceautomationservice/index.md) ### IAnalyticalWorkspace.catalog() Returns factory that can be used to query workspace catalog items - attributes, measures, facts and date data sets. **Signature:** ```typescript catalog(): IWorkspaceCatalogFactory; ``` **Returns:** [IWorkspaceCatalogFactory](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactory/index.md) ### IAnalyticalWorkspace.computedAttributes() Returns service that can be used to manage and query computed attributes. **Signature:** ```typescript computedAttributes(): IWorkspaceComputedAttributesService; ``` **Returns:** [IWorkspaceComputedAttributesService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecomputedattributesservice/index.md) ### IAnalyticalWorkspace.customApplicationSettings() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Returns service that manages the settings that applications store in the workspace. **Signature:** ```typescript customApplicationSettings(): IWorkspaceCustomApplicationSettingsService; ``` **Returns:** [IWorkspaceCustomApplicationSettingsService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecustomapplicationsettingsservice/index.md) ### IAnalyticalWorkspace.dashboards() Returns service that can be used to query and update dashboards. **Signature:** ```typescript dashboards(): IWorkspaceDashboardsService; ``` **Returns:** [IWorkspaceDashboardsService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedashboardsservice/index.md) ### IAnalyticalWorkspace.dataFilters() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Returns service that operates over Data Filters. **Signature:** ```typescript dataFilters(): IDataFiltersService; ``` **Returns:** [IDataFiltersService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idatafiltersservice/index.md) ### IAnalyticalWorkspace.datasets() Returns service that can be used to query data sets defined in this workspace. **Signature:** ```typescript datasets(): IWorkspaceDatasetsService; ``` **Returns:** [IWorkspaceDatasetsService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedatasetsservice/index.md) ### IAnalyticalWorkspace.dateFilterConfigs() Returns service that can be used to query date filter configs. **Signature:** ```typescript dateFilterConfigs(): IDateFilterConfigsQuery; ``` **Returns:** [IDateFilterConfigsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idatefilterconfigsquery/index.md) ### IAnalyticalWorkspace.delete() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Delete the workspace. **Signature:** ```typescript delete(): Promise; ``` **Returns:** Promise<void> ### IAnalyticalWorkspace.execution() Returns execution factory - which is an entry point to triggering executions and thus obtaining analytics from the workspace. **Signature:** ```typescript execution(): IExecutionFactory; ``` **Returns:** [IExecutionFactory](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexecutionfactory/index.md) ### IAnalyticalWorkspace.exportDefinitions() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Returns service that operates over export definitions **Signature:** ```typescript exportDefinitions(): IWorkspaceExportDefinitionsService; ``` **Returns:** [IWorkspaceExportDefinitionsService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceexportdefinitionsservice/index.md) ### IAnalyticalWorkspace.exportTemplates() > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Returns service that can be used to query workspace-level export templates for slide exports. **Signature:** ```typescript exportTemplates(): IWorkspaceExportTemplatesService; ``` **Returns:** [IWorkspaceExportTemplatesService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceexporttemplatesservice/index.md) ### IAnalyticalWorkspace.facts() Returns service that can be used to query additional facts data. **Signature:** ```typescript facts(): IWorkspaceFactsService; ``` **Returns:** [IWorkspaceFactsService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacefactsservice/index.md) ### IAnalyticalWorkspace.genAI() > **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Returns service that can be used to access GenAI services. **Signature:** ```typescript genAI(): IGenAIService; ``` **Returns:** [IGenAIService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igenaiservice/index.md) ### IAnalyticalWorkspace.getDescriptor() Returns details about the analytical workspace. Throws error in case the workspace does not exist. **Signature:** ```typescript getDescriptor(includeParentPrefixes?: boolean): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | includeParentPrefixes | boolean | _(Optional)_ Optional parameter to include parent prefixes in the workspace descriptor. | **Returns:** Promise<[IWorkspaceDescriptor](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedescriptor/index.md)> ### IAnalyticalWorkspace.getParentWorkspace() Returns parent analytical workspace when this workspace has a parent, undefined otherwise. **Signature:** ```typescript getParentWorkspace(): Promise; ``` **Returns:** Promise<[IAnalyticalWorkspace](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalworkspace/index.md) | undefined> ### IAnalyticalWorkspace.insights() Returns service that can be used to query and update insights. **Signature:** ```typescript insights(): IWorkspaceInsightsService; ``` **Returns:** [IWorkspaceInsightsService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceinsightsservice/index.md) ### IAnalyticalWorkspace.keyDriverAnalysis() Returns service that can be used to work with key drivers. **Signature:** ```typescript keyDriverAnalysis(): IWorkspaceKeyDriverAnalysisService; ``` **Returns:** IWorkspaceKeyDriverAnalysisService ### IAnalyticalWorkspace.localization() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Returns service that reports how languages and translations are used in the workspace. **Signature:** ```typescript localization(): IWorkspaceLocalizationService; ``` **Returns:** [IWorkspaceLocalizationService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacelocalizationservice/index.md) ### IAnalyticalWorkspace.logicalModel() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Returns service that reads and changes the logical data model. **Signature:** ```typescript logicalModel(): IWorkspaceLogicalModelService; ``` **Returns:** [IWorkspaceLogicalModelService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacelogicalmodelservice/index.md) ### IAnalyticalWorkspace.measures() Returns service that can be used to query additional measures data. **Signature:** ```typescript measures(): IWorkspaceMeasuresService; ``` **Returns:** [IWorkspaceMeasuresService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacemeasuresservice/index.md) ### IAnalyticalWorkspace.objectPermissions() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Returns service that manages per-object access for catalog attributes, facts and labels. **Signature:** ```typescript objectPermissions(): IWorkspaceObjectPermissionsService; ``` **Returns:** [IWorkspaceObjectPermissionsService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceobjectpermissionsservice/index.md) ### IAnalyticalWorkspace.parameters() Returns service that can be used to query additional parameters data. **Signature:** ```typescript parameters(): IWorkspaceParametersService; ``` **Returns:** [IWorkspaceParametersService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceparametersservice/index.md) ### IAnalyticalWorkspace.permissions() Returns service that can be used to query workspace permissions. **Signature:** ```typescript permissions(): IWorkspacePermissionsService; ``` **Returns:** [IWorkspacePermissionsService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacepermissionsservice/index.md) ### IAnalyticalWorkspace.publisher() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Returns service that can be used to manage page templates, document templates and documents. **Signature:** ```typescript publisher(): IWorkspacePublisherService; ``` **Returns:** [IWorkspacePublisherService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacepublisherservice/index.md) ### IAnalyticalWorkspace.publisherV2() > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Returns service that can be used to manage page templates, document templates and documents in content version 2. **Signature:** ```typescript publisherV2(): IWorkspacePublisherServiceV2; ``` **Returns:** [IWorkspacePublisherServiceV2](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacepublisherservicev2/index.md) ### IAnalyticalWorkspace.references() Returns service that can be used to access references. **Signature:** ```typescript references(): IReferencesService; ``` **Returns:** [IReferencesService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ireferencesservice/index.md) ### IAnalyticalWorkspace.settings() Returns service that can be used to obtain settings that are currently in effect for the workspace. **Signature:** ```typescript settings(): IWorkspaceSettingsService; ``` **Returns:** [IWorkspaceSettingsService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacesettingsservice/index.md) ### IAnalyticalWorkspace.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. **Signature:** ```typescript styling(): IWorkspaceStylingService; ``` **Returns:** [IWorkspaceStylingService](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacestylingservice/index.md) ### IAnalyticalWorkspace.updateDescriptor() Updates the details of the workspace. Throws error in case the workspace does not exist. **Signature:** ```typescript updateDescriptor(descriptor: IWorkspaceDescriptorUpdate): Promise; ``` #### Parameters | Parameter | Type | Description | | --- | --- | --- | | descriptor | [IWorkspaceDescriptorUpdate](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedescriptorupdate/index.md) | properties to update | **Returns:** Promise<[IWorkspaceDescriptor](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacedescriptor/index.md)> ### IAnalyticalWorkspace.userGroups() Returns service that can be used to query workspace user groups. **Signature:** ```typescript userGroups(): IWorkspaceUserGroupsQuery; ``` **Returns:** [IWorkspaceUserGroupsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceusergroupsquery/index.md) ### IAnalyticalWorkspace.users() Returns service that can be used to query workspace users. **Signature:** ```typescript users(): IWorkspaceUsersQuery; ``` **Returns:** [IWorkspaceUsersQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceusersquery/index.md)