Open this page in the API Guide

MetricSetController Class

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

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 MetricSetController : ApiControllerBase

The MetricSetController type exposes the following members.

Constructors
  NameDescription
Public methodMetricSetController
Initializes a new instance of the MetricSetController class.
Top
Methods
  NameDescription
Public methodAddAllElementsToMetricSet
Adds all the elements to the metric set with the specified placement position.
Public methodAddContextualMeasure
Adds a contextual measure to the metric set.
Public methodAddCountMeasureToMetricSet
Adds the count measure to the metric set.
Public methodAddCustomHierarchyGroup
Adds a custom hierarchy group to the metric set.
Public methodAddDynamicHierarchy
Adds a dynamic hierarchy to the metric set.
Public methodAddDynamicMeasure
Adds a dynamic measure to the metric set.
Public methodAddElementToMetricSet
Adds the specified element to the metric set.
Public methodAddParallelPeriodMeasure
Adds a parallel period measure to a metric set.
Public methodAddParallelSlicerMeasure
Adds a parallel slicer measure to a metric set.
Public methodAddReplaceHierarchyOnMetricSet
Adds the specified element + hierarchy to the metric set, or if the element is already on the metric set, updates it to use the hierarchy given.
Public methodAddScriptMeasure
Add a script measure to the metric set.
Public methodAddScriptMetricSet
Generate a script metric set.
Public methodAddStateGroupToMetricSet
Adds a state group to a metric set.
Public methodCancelMeasureSorting
Cancels all measure sorting on a metric set.
Public methodCreateTemporaryCopy
Creates a temporary copy of the metric set.
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 methodGenerateMetricSet
Generates a new metric set.
Public methodGetAnalysisStructure
Gets the metric set's analysis structure.
Protected methodGetClientIdFromCookieOrProvided
Gets the client ID from cookie or from the provided value, which is usually from the query string.
(Inherited from ApiControllerBase.)
Public methodGetMetricSet
Gets a metric set.
Public methodGetMetricSetsByIds
Gets a metric set.
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.)
Protected methodLoadSession
Creates a new caller context associated with the specified session ID. The session is not validated.
(Inherited from ApiControllerBase.)
Public methodMoveElementBeforeOnMetricSet
Moves an element before another element in a metric set.
Public methodParseScript
Parse a script for its structural break down to be used when displaying analysis when creating the script in the UI.
Public methodRemoveAllElementsFromMetricSet
Removes all the elements to the metric set with the specified placement position.
Public methodRemoveElementFromMetricSet
Removes an element from a metric set.
Public methodRemoveStateGroupOnMetricSet(Guid, Guid, Nullable<Guid>)
Deletes the specified state group from a metric set.
Public methodRemoveStateGroupOnMetricSet(Guid, String, Nullable<Guid>)
Deletes the specified custom hierarchy group from a metric set.
Public methodReplaceAnalysisStructure
Replaces the metric set's analysis structure with a different one.
Public methodReplaceElementOnMetricSet
Replaces an element in a metric set.
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 metric set to the given undo frame ID.
Protected methodReturnInvalidWindowsIdentityResponse
Returns the invalid windows identity response to challenge the browser.
(Inherited from ApiControllerBase.)
Public methodSwitchTotalsCalculationRules
Switches the calculation axis for any defined totals calculation rule for the specified measure.
Public methodUpdateElementOnMetricSet
Updates the specified element on the metric set.
Public methodUpdateElementsOnMetricSet
Updates the specified elements on the metric set.
Public methodUpdateMetricSet
Updates a metric set.
Public methodUpdateMetricSetSorting
Updates the sorting and given elements on the metric set.
Public methodUpdateScriptMeasure
Update a script measure.
Public methodUpdateScriptMetricSet
Update a script metric set.
Public methodUpdateStateGroupOnMetricSet
Updates the specified state group in a metric set.
Top
See Also