Class %DeepSee.REST.v2.DataServer

class %DeepSee.REST.v2.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.v2<.class>.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
		9

Summary

Methods
%Array2JSON	%ClassIsLatestVersion	%ClassName	%ConstructResponseFromArray
%ConstructResponseObject	%ConvertErrorStatusToJSON	%CreateObjectFromArray	%DispatchClassMethod
%DispatchGetModified	%DispatchGetProperty	%DispatchMethod	%DispatchSetModified
%DispatchSetMultidimProperty	%DispatchSetProperty	%ErrorToJSON	%Extends
%ExtractDatasourceName	%GetParameter	%IsA	%New
%OriginalNamespace	%PackageName	%SetModified	%SetRequestField
%ValidateRequest	%WaitForProviderResults	AcceptsContentType	AccessCheck
CancelMDXQuery	ConvertParameter	Decrypt	DispatchRequest
DrawCSS3STYLE	DrawHEAD	DrawSTHEAD	DrawSTTitle
DrawSTYLE	DrawTitle	DrawTitleSection	Encrypt
Error	EscapeHTML	EscapeURL	GetAuthChallenge
Http403	Http404	Http405	Http500
HyperEventCall	HyperEventHead	Include	InsertHiddenField
InsertHiddenFields	IsPrivate	Link	Login
OnErrorSetup	OnHTTPHeader	OnHandleCorsRequest	OnHandleOptionsRequest
OnLoginPage	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreDispatch	OnPreHTTP	OnPreHyperEvent
OnSecurityTokenPage	Page	QuoteJS	ReportHttpStatusCode
RewriteURL	SetResponseHeaderIfEmpty	ShowError	StartTimer
StatusToJSON	StatusToProxyObject	StopTimer	SupportedVerbs
Test	ThrowError	UnescapeHTML	UnescapeURL
UpdateQueryResults	WriteDSTIMEForClass	WriteJSONfromDrillthrough	WriteJSONfromKPI
WriteJSONfromMDX	WriteJSONfromPivot

Methods

• 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

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

• classmethod Test(namespace As %String) as %Status

Test method to confirm connection in the service type

• classmethod UpdateQueryResults(namespace As %String, pQueryToken) as %Status

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

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

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

• classmethod WriteJSONfromKPI(namespace As %String) as %Status

Run any compiled KPI and return the associated JSON resultset.

• classmethod WriteJSONfromMDX(namespace As %String) as %Status

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

• classmethod WriteJSONfromPivot(namespace As %String) as %Status

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

Class Reference IRIS for UNIX 2024.1.2
Documentation Search