Skip to main content

%DeepSee.REST.v3.InfoServer

class %DeepSee.REST.v3.InfoServer extends %DeepSee.REST.REST

This class is responsible for creating the JSON response to the DeepSee REST informational services. For examples and a full list of available services see the documentation for %DeepSee.REST.v3<.class>.

Method Inventory

Methods

classmethod GetConfig(namespace, pApplication As %String = "") as %Status
Fetch custom configuration for pApplication.
classmethod SetConfig(namespace, pApplication As %String = "") as %Status
Store custom confguration information for the current user. One JSON document may be stored per user under any given pApplication.
classmethod Test(namespace As %String) as %Status
Test method to confirm connection in the service type
classmethod WriteCubeList(namespace As %String) as %Status
Return a list of available cubes on the system.
classmethod WriteDashboardList(namespace As %String) as %Status
Return a list of available dashboards on the system.
classmethod WriteDataSourceList(namespace As %Status, pSource) as %Status
Get all data sources including "pivot", "kpi","metric"
classmethod WriteDetailsForPivotVariable(namespace As %String, pUrl) as %Status
Return details for a given pivot variable with logical name pVariableName, available in pCubeName.
classmethod WriteFavoritesList(namespace As %String) as %String
Return a list of favorites for the current user.
classmethod WriteFilterMembers(namespace As %String, pUrl) as %Status
Return the available members for a filter defined by pSpec within the context of pCube.
classmethod WriteFiltersForDataSource(namespace As %String, pDataSource) as %Status
Retrieve the list of available filters for a given pCube
classmethod WriteKPIList(namespace As %String)
Retrieve the list of available KPIs.
classmethod WriteListingFieldsForCube(namespace As %String, pCubeName) as %Status
Return a list of available listing fields for pCubeName.
classmethod WriteListingsForCube(namespace As %String, pDataSource) as %Status
Return a list of available listings for pDataSource.
classmethod WriteMeasuresForCube(namespace As %String, pCubeName) as %Status
Return a list of available measures for pCubeName.
classmethod WriteMetricList(namespace As %String) as %Status
Return a list of available metrics on the system.
classmethod WriteNamedFiltersForCube(namespace As %String, pCubeName) as %Status
Return a list of available named filters for pCubeName.
classmethod WritePivotList(namespace As %String) as %Status
Return a list of available pivots on the system. Optionally the request can control the contents of the list via POSTing the variables:
- BASECUBE: Limit the list only to pivots that are based on this cube.
- HIDDEN: If true, include pivots that have been stored as local copies or are currently in the trash.
classmethod WritePivotVariablesForCube(namespace As %String, pCubeName) as %Status
Return a list of available pivot variables for pCubeName.
classmethod WriteQualityMeasuresForCube(namespace As %String, pCubeName) as %Status
Return a list of available quality measures for pCubeName.
classmethod WriteTermlistList(namespace As %String) as %Status
Return a list of term lists defined in the current namespace.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab