IAnalyticalWorkspace
Represents an analytical workspace hosted on a backend.
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 |
|---|---|---|---|
| string |
Methods
Method | Description |
|---|---|
Returns service that can be used to manage access control records for the workspace. | |
(ALPHA) Returns service that can be used to query AI agents available in this workspace. | |
(ALPHA) Returns service that operates over attribute hierarchies | |
Returns service that can be used to query additional attributes and attribtue display forms data, and their elements. | |
(ALPHA) Returns service that can be used to query and update workspace automations. | |
Returns factory that can be used to query workspace catalog items - attributes, measures, facts and date data sets. | |
Returns service that can be used to manage and query computed attributes. | |
(ALPHA) Returns service that manages the settings that applications store in the workspace. | |
Returns service that can be used to query and update dashboards. | |
(ALPHA) Returns service that operates over Data Filters. | |
Returns service that can be used to query data sets defined in this workspace. | |
Returns service that can be used to query date filter configs. | |
(ALPHA) Delete the workspace. | |
Returns execution factory - which is an entry point to triggering executions and thus obtaining analytics from the workspace. | |
(ALPHA) Returns service that operates over export definitions | |
(BETA) Returns service that can be used to query workspace-level export templates for slide exports. | |
Returns service that can be used to query additional facts data. | |
(BETA) Returns service that can be used to access GenAI services. | |
Returns details about the analytical workspace. Throws error in case the workspace does not exist. | |
Returns parent analytical workspace when this workspace has a parent, undefined otherwise. | |
Returns service that can be used to query and update insights. | |
Returns service that can be used to work with key drivers. | |
(ALPHA) Returns service that reports how languages and translations are used in the workspace. | |
(ALPHA) Returns service that reads and changes the logical data model. | |
Returns service that can be used to query additional measures data. | |
(ALPHA) Returns service that manages per-object access for catalog attributes, facts and labels. | |
Returns service that can be used to query additional parameters data. | |
Returns service that can be used to query workspace permissions. | |
(ALPHA) Returns service that can be used to manage page templates, document templates and documents. | |
(ALPHA) Returns service that can be used to manage page templates, document templates and documents in content version 2. | |
Returns service that can be used to access references. | |
Returns service that can be used to obtain settings that are currently in effect for the workspace. | |
Returns service that can be used to obtain workspace styling settings. These settings specify for instance what colors should be used in the charts. | |
Updates the details of the workspace. Throws error in case the workspace does not exist. | |
Returns service that can be used to query workspace user groups. | |
Returns service that can be used to query workspace users. |
Property details
IAnalyticalWorkspace.workspaceproperty
readonly workspace: string;
Method details
IAnalyticalWorkspace.accessControl()method
Returns service that can be used to manage access control records for the workspace.
accessControl(): IWorkspaceAccessControlService;
Returns
IAnalyticalWorkspace.agents()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that can be used to query AI agents available in this workspace.
agents(): IWorkspaceAgentsService;
Returns
IAnalyticalWorkspace.attributeHierarchies()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that operates over attribute hierarchies
attributeHierarchies(): IAttributeHierarchiesService;
Returns
IAnalyticalWorkspace.attributes()method
Returns service that can be used to query additional attributes and attribtue display forms data, and their elements.
attributes(): IWorkspaceAttributesService;
Returns
IAnalyticalWorkspace.automations()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that can be used to query and update workspace automations.
automations(): IWorkspaceAutomationService;
Returns
IAnalyticalWorkspace.catalog()method
Returns factory that can be used to query workspace catalog items - attributes, measures, facts and date data sets.
catalog(): IWorkspaceCatalogFactory;
Returns
IAnalyticalWorkspace.computedAttributes()method
Returns service that can be used to manage and query computed attributes.
computedAttributes(): IWorkspaceComputedAttributesService;
Returns
IAnalyticalWorkspace.customApplicationSettings()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that manages the settings that applications store in the workspace.
customApplicationSettings(): IWorkspaceCustomApplicationSettingsService;
Returns
IAnalyticalWorkspace.dashboards()method
Returns service that can be used to query and update dashboards.
dashboards(): IWorkspaceDashboardsService;
Returns
IAnalyticalWorkspace.dataFilters()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that operates over Data Filters.
dataFilters(): IDataFiltersService;
Returns
IAnalyticalWorkspace.datasets()method
Returns service that can be used to query data sets defined in this workspace.
datasets(): IWorkspaceDatasetsService;
Returns
IAnalyticalWorkspace.dateFilterConfigs()method
Returns service that can be used to query date filter configs.
dateFilterConfigs(): IDateFilterConfigsQuery;
Returns
IAnalyticalWorkspace.delete()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Delete the workspace.
delete(): Promise<void>;
Returns
Promise<void>
IAnalyticalWorkspace.execution()method
Returns execution factory - which is an entry point to triggering executions and thus obtaining analytics from the workspace.
execution(): IExecutionFactory;
Returns
IAnalyticalWorkspace.exportDefinitions()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that operates over export definitions
exportDefinitions(): IWorkspaceExportDefinitionsService;
Returns
IAnalyticalWorkspace.exportTemplates()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Returns service that can be used to query workspace-level export templates for slide exports.
exportTemplates(): IWorkspaceExportTemplatesService;
Returns
IAnalyticalWorkspace.facts()method
Returns service that can be used to query additional facts data.
facts(): IWorkspaceFactsService;
Returns
IAnalyticalWorkspace.genAI()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Returns service that can be used to access GenAI services.
genAI(): IGenAIService;
Returns
IAnalyticalWorkspace.getDescriptor()method
Returns details about the analytical workspace. Throws error in case the workspace does not exist.
getDescriptor(includeParentPrefixes?: boolean): Promise<IWorkspaceDescriptor>;
Parameters
Parameter | Type | Description |
|---|---|---|
includeParentPrefixes | boolean | (Optional) Optional parameter to include parent prefixes in the workspace descriptor. |
Returns
Promise<IWorkspaceDescriptor>
IAnalyticalWorkspace.getParentWorkspace()method
Returns parent analytical workspace when this workspace has a parent, undefined otherwise.
getParentWorkspace(): Promise<IAnalyticalWorkspace | undefined>;
Returns
Promise<IAnalyticalWorkspace | undefined>
IAnalyticalWorkspace.insights()method
Returns service that can be used to query and update insights.
insights(): IWorkspaceInsightsService;
Returns
IAnalyticalWorkspace.keyDriverAnalysis()method
Returns service that can be used to work with key drivers.
keyDriverAnalysis(): IWorkspaceKeyDriverAnalysisService;
Returns
IWorkspaceKeyDriverAnalysisService
IAnalyticalWorkspace.localization()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that reports how languages and translations are used in the workspace.
localization(): IWorkspaceLocalizationService;
Returns
IAnalyticalWorkspace.logicalModel()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that reads and changes the logical data model.
logicalModel(): IWorkspaceLogicalModelService;
Returns
IAnalyticalWorkspace.measures()method
Returns service that can be used to query additional measures data.
measures(): IWorkspaceMeasuresService;
Returns
IAnalyticalWorkspace.objectPermissions()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that manages per-object access for catalog attributes, facts and labels.
objectPermissions(): IWorkspaceObjectPermissionsService;
Returns
IAnalyticalWorkspace.parameters()method
Returns service that can be used to query additional parameters data.
parameters(): IWorkspaceParametersService;
Returns
IAnalyticalWorkspace.permissions()method
Returns service that can be used to query workspace permissions.
permissions(): IWorkspacePermissionsService;
Returns
IAnalyticalWorkspace.publisher()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that can be used to manage page templates, document templates and documents.
publisher(): IWorkspacePublisherService;
Returns
IAnalyticalWorkspace.publisherV2()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Returns service that can be used to manage page templates, document templates and documents in content version 2.
publisherV2(): IWorkspacePublisherServiceV2;
Returns
IAnalyticalWorkspace.references()method
Returns service that can be used to access references.
references(): IReferencesService;
Returns
IAnalyticalWorkspace.settings()method
Returns service that can be used to obtain settings that are currently in effect for the workspace.
settings(): IWorkspaceSettingsService;
Returns
IAnalyticalWorkspace.styling()method
Returns service that can be used to obtain workspace styling settings. These settings specify for instance what colors should be used in the charts.
styling(): IWorkspaceStylingService;
Returns
IAnalyticalWorkspace.updateDescriptor()method
Updates the details of the workspace. Throws error in case the workspace does not exist.
updateDescriptor(descriptor: IWorkspaceDescriptorUpdate): Promise<IWorkspaceDescriptor>;
Parameters
Parameter | Type | Description |
|---|---|---|
descriptor | properties to update |
Returns
Promise<IWorkspaceDescriptor>
IAnalyticalWorkspace.userGroups()method
Returns service that can be used to query workspace user groups.
userGroups(): IWorkspaceUserGroupsQuery;
Returns
IAnalyticalWorkspace.users()method
Returns service that can be used to query workspace users.
users(): IWorkspaceUsersQuery;
Returns