Skip to main content

%DeepSee.REST.v3.DataServer

Class %DeepSee.REST.v3.DataServer Extends %DeepSee.REST.REST

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

XDatas​

UrlMap​

XData UrlMap

Methods​

%ValidateRequest​

ClassMethod %ValidateRequest(pUrl As %String, pMethod As %String) As %Status

Perform specific validation for the service that will handle the request. This is used as a callback in each service that extends %DeepSee.REST

WriteJSONfromMDX​

ClassMethod WriteJSONfromMDX(namespace As %String) As %Status

Run any valid MDX (SELECT,DRILLTHROUGH,DRILLFACTS) query and returns the JSON resultset.

WriteJSONfromDrillthrough​

ClassMethod WriteJSONfromDrillthrough(namespace As %String)

Run a listing from either the source or the fact table. Specific listings or a list of fields may be POSTed to add to the query.

WriteJSONfromPivot​

ClassMethod WriteJSONfromPivot(namespace As %String) As %Status

Run any stored pivot table and return the associated JSON resultset.

WriteJSONfromKPI​

ClassMethod WriteJSONfromKPI(namespace As %String) As %Status

Run any compiled KPI and return the associated JSON resultset.

WriteJSONfromKPIDrillthrough​

ClassMethod WriteJSONfromKPIDrillthrough(namespace As %String) As %Status

Run a listing from a KPI data source. A specific listing may be POSTed to access supported listings as defined by the source.

CancelMDXQuery​

ClassMethod CancelMDXQuery(namespace As %String, pQueryToken) As %Status

Cancel a running query using the cubeKey and queryKey provided in a previously returned resultset with ResultsComplete=0.

UpdateQueryResults​

ClassMethod UpdateQueryResults(namespace As %String, pQueryToken) As %Status

Try to obtain results from a previous query that returned incomplete results.

WriteJSONDashboardDef​

ClassMethod WriteJSONDashboardDef(namespace As %String, pDashboardName) As %Status

Return the stored definition for pDashboardName.

WriteJSONPivotDef​

ClassMethod WriteJSONPivotDef(namespace As %String, pPivotName) As %Status

Return the stored definition for pPivotName.

WriteJSONTermList​

ClassMethod WriteJSONTermList(namespace As %String, pTermList As %String) As %Status

Return values stored in pTermList.

WriteDSTIMEForClass​

ClassMethod WriteDSTIMEForClass(namespace As %String, pClassName) As %Status

Retrieve the most recently processed ^OBJ.DSTIME stamp(s) for one or more classes from the ^DeepSee.Update global.

AddFavorite​

ClassMethod AddFavorite(namespace As %String, pName As %String) As %Status

Store pName as a favorite for the current user.

RemoveFavorite​

ClassMethod RemoveFavorite(namespace As %String, pName As %String) As %Status

Remove pName as a favorite for the current user.

Test​

ClassMethod Test(namespace As %String) As %Status

Test method to confirm connection in the service type