Open this page in the API Guide

DataCubeController Class

The REST API controller for the DataCube.
Inheritance Hierarchy
System.Object
  Microsoft.AspNetCore.Mvc.ControllerBase
    Dundas.BI.WebApi.Controllers.ApiControllerBase
      Dundas.BI.WebApi.Controllers.DataCubeController

Namespace:  Dundas.BI.WebApi.Controllers
Assembly:  Dundas.BI.WebApi (in Dundas.BI.WebApi.dll) Version: 2.0.0.0 (25.1.0.1000)
Syntax
public class DataCubeController : ApiControllerBase

The DataCubeController type exposes the following members.

Constructors
  NameDescription
Public methodDataCubeController
Initializes a new instance of the DataCubeController class.
Top
Methods
  NameDescription
Public methodAddSelectTransform
Adds a new select transform to the data cube.
Public methodBuildStorage
Starts processing the data cube into the data cube's storage option. This call will not wait for the processing to finish to return.
Public methodChangeAnalysisElementVisibility
Shows or hides an analysis element within the data cube.
Public methodClearDataResultCache
Clears all the results based on the specified cube from the data result cache.
Public methodConnectTransform
Connect two transforms together.
Public methodCreateParameter
Creates a new parameter on the transform. Parameters for Output Element filtering or Transform setting can be created.
Public methodCreateStructureSelectionParameter
Creates a new Structure Selection Parameter to be created on the transform.
Public methodDeleteParameter
Deletes a parameter on the transform.
Public methodDeletePlaceholder
Deletes a placeholder on the transform.
Public methodDeleteRelationship
Deletes the relationship by join for the given data cube.
Public methodDisconnectTransform
Disconnect the output data connector of a transform.
Public methodDiscoverColumns
Refreshes the elements of the specified transform on a data cube.
Protected methodEnsureCallerContext
If the current context is not already the specified context, creates a new caller context which is a clone of the specified context and sets it as the current one.
(Inherited from ApiControllerBase.)
Protected methodEnsureFormFileMultipartContent
Ensures when form files are access the content is MIME multi-part which we want.
(Inherited from ApiControllerBase.)
Public methodGenerateDataCube
Generates a new data cube.
Protected methodGetClientIdFromCookieOrProvided
Gets the client ID from cookie or from the provided value, which is usually from the query string.
(Inherited from ApiControllerBase.)
Public methodGetCustomConfigurationUI
Gets the custom configuration UI for the specified transform in the system.
Public methodGetDataCube
Gets a data cube.
Public methodGetDataCubeAndChildren
Retrieves a data cube and it's parent cubes.
Public methodGetDataCubeAndParents
Retrieves a data cube and it's parent cubes.
Public methodGetDataCubeInfos
Gets the collection of DataCubeInfoData for the specified IDs.
Public methodGetRelationships
Gets the relationships for the given data cube.
Public methodGetSchedule
Gets the schedule for the data cube.
Protected methodGetService<T>
Gets the requested service.
(Inherited from ApiControllerBase.)
Protected methodGetSessionIdFromCookieHeaderOrProvided
Gets the session ID from cookie, the authorization header or from the provided value, which is usually from the query string.
(Inherited from ApiControllerBase.)
Public methodInsertTransform
Inserts the specified transform into a data cube.
Public methodIsTenantWarehouseScheduleSupported
Retrieves a data cube and it's parent cubes.
Protected methodLoadSession
Creates a new caller context associated with the specified session ID. The session is not validated.
(Inherited from ApiControllerBase.)
Public methodPreviewTransform
Gets preview data for the specified transform from a data cube.
Public methodPreviewTransformStatistics
Gets preview statistics for the specified transform from a data cube.
Public methodRefreshTransform
Refreshes the elements of the specified transform on a data cube.
Public methodRemoveSchedule
Removes the schedule from the specified data cube.
Public methodRemoveTransform
Removes the specified transform from a data cube.
Public methodReplaceDataConnector
Replaces the data connector of a manual select transform. This is used to change one data connector with another to effectively replace the data source of the transform.
Public methodReplaceElementNames
Replaces the element names on a select transform. This is used to change an element to use a different native column.
Public methodReplaceStructure
Replaces the structure of a select transform. This is used to change one structure with another to effectively replace the source of a select transform.
Public methodRequestBridgeParameter
Creates a new bridge parameter to be created on the data process.
Protected methodRequestFirstFormFile
Retrieves the first form file from the request.
(Inherited from ApiControllerBase.)
Protected methodRequestFormFiles
Retrieves the form files from the request.
(Inherited from ApiControllerBase.)
Public methodRestoreUndoFrame
Restores the data cube to the given undo frame ID.
Protected methodReturnInvalidWindowsIdentityResponse
Returns the invalid windows identity response to challenge the browser.
(Inherited from ApiControllerBase.)
Public methodSaveResultConnector
Updates the result connector element with the options sent.
Public methodScheduleDataWarehouseCubes
Configure data warehousing storage and the referenced cubes processing priorities for the specified data cubes.
Public methodScheduleInMemoryCubes
Configure in-memory storage and the referenced cubes processing priorities for the specified data cubes.
Public methodScheduleStorage
Creates a scheduled task for storing the data cube in the warehouse or in-memory.
Public methodScheduleTenantCubeOverride
Configure a tenant processing schedule override.
Public methodSetupCubeReferencesProcess
Configure the referenced cubes processing priorities for the specified data cubes.
Public methodStorageInfo
Retrieves a data cube's storage information.
Public methodTestBridgeParameterScript
Tests a bridge parameter's attached parameter information script by passing a value and seeing if a parameter value is returned or an error is raised.
Public methodTestHierarchyPromotion
Tests to see whether a hierarchy promotion is compatible.
Public methodUpdateDataCube
Updates a data cube.
Public methodUpdateDataCubeStorageType
Updates the storage type of the specified data cube.
Public methodUpdateRelationships
Updates the relationships for the given data cube and transform.
Public methodUpdateTransform
Updates the specified transform on a data cube.
Top
See Also