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>.

XDatas​

UrlMap​

XData UrlMap

Methods​

GetConfig​

ClassMethod GetConfig(namespace, pApplication As %String = "") As %Status

Fetch custom configuration for pApplication.

SetConfig​

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.

WriteFiltersForDataSource​

ClassMethod WriteFiltersForDataSource(namespace As %String, pDataSource) As %Status

Retrieve the list of available filters for a given pCube

WriteFilterMembers​

ClassMethod WriteFilterMembers(namespace As %String, pUrl) As %Status

Return the available members for a filter defined by pSpec within the context of pCube.

WriteCubeList​

ClassMethod WriteCubeList(namespace As %String) As %Status

Return a list of available cubes on the system.

WriteDataSourceList​

ClassMethod WriteDataSourceList(namespace As %Status, pSource) As %Status

Get all data sources including "pivot", "kpi","metric"

WriteKPIList​

ClassMethod WriteKPIList(namespace As %String)

Retrieve the list of available KPIs.

WritePivotList​

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.

WriteMetricList​

ClassMethod WriteMetricList(namespace As %String) As %Status

Return a list of available metrics on the system.

WriteDashboardList​

ClassMethod WriteDashboardList(namespace As %String) As %Status

Return a list of available dashboards on the system.

WriteListingsForCube​

ClassMethod WriteListingsForCube(namespace As %String, pDataSource) As %Status

Return a list of available listings for pDataSource.

WriteMeasuresForCube​

ClassMethod WriteMeasuresForCube(namespace As %String, pCubeName) As %Status

Return a list of available measures for pCubeName.

WriteListingFieldsForCube​

ClassMethod WriteListingFieldsForCube(namespace As %String, pCubeName) As %Status

Return a list of available listing fields for pCubeName.

WriteQualityMeasuresForCube​

ClassMethod WriteQualityMeasuresForCube(namespace As %String, pCubeName) As %Status

Return a list of available quality measures for pCubeName.

WriteNamedFiltersForCube​

ClassMethod WriteNamedFiltersForCube(namespace As %String, pCubeName) As %Status

Return a list of available named filters for pCubeName.

WritePivotVariablesForCube​

ClassMethod WritePivotVariablesForCube(namespace As %String, pCubeName) As %Status

Return a list of available pivot variables for pCubeName.

WriteDetailsForPivotVariable​

ClassMethod WriteDetailsForPivotVariable(namespace As %String, pUrl) As %Status

Return details for a given pivot variable with logical name pVariableName, available in pCubeName.

WriteFavoritesList​

ClassMethod WriteFavoritesList(namespace As %String) As %String

Return a list of favorites for the current user.

WriteTermlistList​

ClassMethod WriteTermlistList(namespace As %String) As %Status

Return a list of term lists defined in the current namespace.

Test​

ClassMethod Test(namespace As %String) As %Status

Test method to confirm connection in the service type